1IPRAYTIME(1)                     User Commands                    IPRAYTIME(1)
2
3
4

NAME

6       ipraytime - An Islamic Prayer Times Calculator
7

SYNOPSIS

9       ipraytime   [--date   yyyymmdd]   [--latitude   real_num]  [--longitude
10       real_num]  [--utcdiff   real_num]   [--method   int_num]   [--ishaangle
11       real_num] [--fajrangle real_num] [--dst int_num] [--dst-start yyyymmdd]
12       [--dst-end yyyymmdd] [--round int_num] [--extreme int_num] [--sea-level
13       int_num]  [--month  [int_num]]  [--year  [int_num]]  [--file pref_file]
14       [--end] [--brief] [--help]
15

DESCRIPTION

17       The ipraytime program is a generator of Islamic prayer  time  schedules
18       for  any  given  location.   ipraytime  also calculates the appropriate
19       Qibla direction (heading towards the Kabaa) based on  the  given  loca‐
20       tion.   ipraytime in its single day format is also capable of calculat‐
21       ing Imsaak times (ie. the times when one is to start fasting).   ipray‐
22       time  is  also  capable of generating a schedule for an entire month or
23       year based on command-line arguments.  The  program  is  also  able  to
24       print  the  schedules  for  the rest of the current month so as to skip
25       days that have already  passed.   ipraytime  also  has  a  minimalistic
26       option to simply show a one liner of the prayer times in its single day
27       format.
28
29       ipraytime has multiple ways of conveying info and settings to it.   The
30       order  of precedence (from highest to lowest) is, the command-line fol‐
31       lowed by the environment variable setting (IPT_DATA) to the data  being
32       presented  in ipraytime's RC file (~/.iprayrc) in one's home directory.
33       If none of the above is found, ipraytime  defaults  to  using  Makkah's
34       location with the host machine's current date settings.
35

OPTIONS

37       ipraytime  follows the usual GNU command line syntax, with long options
38       starting with two dashes (`-').  A summary  of  all  options  is  noted
39       below:
40
41       -h, --help
42              Show summary of options
43
44       -d, --date yyyymmdd
45              Specify the Gregorian date to use where `y' stands for year, `m'
46              for month and `d' for day
47
48       -lat, --latitude real_num
49              Specify the latitude setting to use  during  calculations.   The
50              value could be any real number
51
52       -lon, --longitude real_num
53              Specify  the  longitude setting to use during calculations.  The
54              value could be any real number
55
56       -sea, --sea-level real_num
57              Specify height above Sea level (in meters)
58
59       -u, --utcdiff real_num
60              Specify the difference between the specified timezone  and  that
61              of GMT/UTC.  The value could be any real number
62
63       -a, --anglemethod [int_num]
64              Specify  which angle method calculation to use.  The angle meth‐
65              ods that are currently supported by ipraytime are,
66
67               1   Egyptian General Authority of Survey
68                     Fajr/Isha Angle   : 20/18
69                     Used in           : Africa, Indonesia, Iraq,
70                                         Jordan, Lebanon, Malaysia,
71                                         Singapore, Syria,
72                                         Parts of the USA
73
74               2   University of Islamic Sciences, Karachi (Shaf'i)
75                     Fajr/Isha Angle   : 18/18
76                     Used in           : Iran, Kuwait,
77                                         Parts of Europe
78
79               3   University of Islamic Sciences, Karachi (Hanafi)
80                     Fajr/Isha Angle   : 18/18
81                     Used in           : Afghanistan, Bangladesh,
82                                         India
83
84               4   Islamic Society of North America
85                     Fajr/Isha  Angle  : 15/15
86                     Used in           : Canada, Parts of UK,
87                                         Parts of USA
88
89               5   Muslim World League (MWL)
90                     Fajr/Isha  Angle  : 18/17
91                     Used in           : Parts of Europe,
92                                         Far East, Parts of USA
93
94               6   Umm Al-Qurra University
95                     Fajr/Isha Angl e  : 19/0
96                     Isha Interval     : 90 minutes from Al-Maghrib
97                                         prayer but set to 120
98                                         during Ramadan.
99                     Used in           : Saudi Arabia
100
101               7   Fixed Isha Angle Interval (always 90)
102                     Fajr/Isha Angle   : 19.5/0
103                     Isha Interval     : 90 minutes from Al-Maghrib
104                                         prayer
105                     Used in           : Bahrain, Oman, Qatar, UAE
106
107               8   Egyptian General Authority of Survey (Egypt)
108                     Fajr/Isha Angle   : 19.5/17.5
109                     Used in           : Egypt
110
111       -fa, --fajrangle [real_num]
112              Specify which angle to use for Fajr. Will override the  one  set
113              by the --anglemethod.
114
115       -ia, --ishaangle [real_num]
116              Specify  which  angle to use for Isha. Will override the one set
117              by the --anglemethod.
118
119       -s, --dst [int_num]
120              By default, ipraytime uses the host's machine timezone  informa‐
121              tion  to  determine whether daylight saving time is in effect or
122              not. If this information is unavailable or  not  accurate,  this
123              option  provides the means to explicitly set the DST status. Set
124              this to 0 to completely disable daylight saving time. Set it  to
125              1 to always add one hour to the computed prayer times.
126
127       -ss, --dst-start yyyymmdd
128       -se, --dst-end yyyymmdd
129              Specify  a  range  of  dates  where  day light saving time is in
130              effect for your location. For example:
131
132                   ipraytime --dst-start 20040328 --dst-end 20041029
133
134       -m, --month [int_num]
135              Specify  to  print  either  current  month's  schedule  or   the
136              passed-in value's month schedule.
137
138       -y, --year [int_num]
139              Specify to print either current year's schedule or the passed-in
140              value's year schedule.
141
142       -f, --file pref_file
143              Specify filename to load  which  contains  user's  settings  and
144              preferences.
145
146       -e, --end
147              Specify  to  continue  with  schedule  printing until the end of
148              specified month.
149
150       -b, --brief
151              Specify to print a brief one-liner output for single day mode.
152
153       -h12, --regular-hour
154              Display the prayer times in regular  time  instead  of  military
155              time.
156
157       -r, --round [int_num]
158              Specify  a  method  for  rounding seconds. The supported methods
159              are,
160
161               0   No Rounding. Completely ignore the computed seconds value.
162
163               1   Regular Rounding. If seconds are equal to 30 or above,  add
164                   1 minute.
165
166               2   Special Rounding. Similar to regular rounding but we always
167                   round down for Shurooq  and  Imsaak  times.  (This  is  the
168                   default method)
169
170               3   Aggressive Rounding. Similar to Special Rounding but we add
171                   1 minute if the seconds value are  equal  to  1  second  or
172                   more.
173
174       -x, --extreme [int_num]
175              Specify  a method for prayer times calculations at high (49+) or
176              extreme (66+) latitudes. Prayer times calculations relies  heav‐
177              ily  on  astronomical  events.  At these latitudes some of those
178              events do not occur at all, or are impossible to precisely  cal‐
179              culate  using  conventional means. For example, at certain loca‐
180              tions the sun never moves below the horizon to the  position  of
181              the amount of Fajr angle degrees specified, therefore there will
182              be no real Fajr time at that  location.  The  supported  extreme
183              methods are:
184
185               Note: Methods that have the If Invalid keyword are applied only
186               when ipraytime is unable to calculate these times. Methods that
187               have the Always keyword are applied always.
188
189               0   None. If unable to calculate, leave as 99:99
190
191               1   Nearest Latitude (Aqrab Al-Bilaad): All prayers [Always]
192
193               2   Nearest Latitude (Aqrab Al-Bilaad): Fajr and Isha [Always]
194
195               3   Nearest   Latitude  (Aqrab  Al-Bilaad):   All  prayers  [If
196                   Invalid]
197
198               4   Nearest Good Day (Aqrab Al-Ayyam): All prayers [Always]
199
200               5   Nearest Good Day (Aqrab Al-Ayyam): All prayers [If Invalid]
201                   (This is the default method)
202
203               Note:  All  the  extreme  methods following below do not have a
204               proof in traditional Shari'a (Fiqh)  resources.  These  methods
205               were  introduced  by  modern day Muslim scholars and scientists
206               for practical reasons only.
207
208               6   Seventh of Night: Fajr and Isha [Always]
209
210               7   Seventh of Night: Fajr and Isha [If Invalid]
211
212               8   Seventh of Day: Fajr and Isha [Always]
213
214               9   Seventh of Day: Fajr and Isha [If Invalid]
215
216               10  Half of the Night: Fajr and Isha [Always]
217
218               11  Half of the Night: Fajr and Isha [If Invalid]
219
220               Note: To use the next two methods, you  will  need  to  specify
221               FajrInterval and IshaInterval in your configuration file.
222
223               12  Minutes from Shorooq/Maghrib: Fajr and Isha [Always]
224
225               13  Minutes from Shorooq/Maghrib: Fajr and Isha [If invalid]
226

CONFIGURATION

228       ipraytime  is  capable  of  loading  settings from a configuration file
229       (~/.iprayrc). The default location of the  configuration  file  can  be
230       changed  using  the --file option. The content of the file should be in
231       the following syntax, `variable_string: value'. See the  EXAMPLES  sec‐
232       tion  for  usage  examples.  Below  is a list of all supported settings
233       which can be used in the configuration file:
234
235   Location Settings
236       City
237         Specifies an informational city name string to be displayed for  ref‐
238         erence
239
240       Latitude
241         Specify  the  latitude setting to use during calculations.  The value
242         could be any real number
243
244       Longitude
245         Specify the longitude setting to use during calculations.  The  value
246         could be any real number
247
248       UTC
249         Specify  the  difference  between  the specified timezone and that of
250         GMT/UTC.  The value could be any real number
251
252       SeaLevel
253         Specify height above Sea level (in meters)
254
255       Pressure
256         Specify the atmospheric pressure in millibars. The default  value  is
257         1010.
258
259       Temperature
260         Specify the temperature in Celsius degree. The default value is 10.
261
262   Calculation Method Settings
263       AngleMethod
264         Specify which angle method calculation to use.  The value needs to be
265         a  positive  integer  of  one  of  the  supported  methods.  See  the
266         --anglemethod option for more information.
267
268       Mathhab
269         Specify which mathhab to use in one's calculations.  The current sup‐
270         ported value are 1 for Shaf'i and 2 for Hanafi
271
272       OffsetList
273         Specify a list of values in minutes to add or subtract any amount  of
274         minutes  from  the  daily  computed prayer times. For example, If you
275         want to add 30 seconds to Maghrib and subtract 2 minutes  from  Isha,
276         you will set this option to `0 0 0 0 0.5 -2'.
277
278       FajrAngle
279         Specify  the fajr angle to use during calculations. Will override the
280         values of the specified method.
281
282       IshaAngle
283         Specify the isha angle to use during calculations. Will override  the
284         values of the specified method.
285
286       ImsaakAngle
287         Specify  imsaak  and  fajr angle difference. The default value is 1.5
288         degrees.
289
290       FajrInterval
291         Specify the number of minutes between fajr and shorooq.  This  should
292         be a positive integer.
293
294       IshaInterval
295         Specify  the  number of minutes between Isha and Maghrib. This should
296         be a positive integer.
297
298       ImsaakInterval
299         Specify a difference in minutes between imsaak and fajr. The  default
300         Imsaak interval from fajr is 10 minutes if the FajrInterval is set.
301
302       ExtremeMethod
303         Specify  which  method  to  use  for high and extreme latitudes.  The
304         value needs to be an integer of one of the supported extreme methods.
305         See  descriptions of the --extreme option for a list of the supported
306         methods.
307
308       NearestLatitude
309         Specify the latitude Used for the `Nearest Latitude' extreme methods.
310         The default is at 48.5 degrees.
311
312       RoundMethod
313         Specify  which method to use for rounding seconds. The value needs to
314         be an integer of one of the  supported  rounding  methods.   See  the
315         --round option for a list of the supported methods.
316
317   Daylight Saving Time Settings
318       DST
319         Specify  the  current DST status. Set this to 0 to completely disable
320         daylight saving time. Or set it to 1 to always add one  hour  to  the
321         computed prayer times. See the --dst option for more information.
322
323       DST-Start
324         Specify  the  start  date  when daylight saving time adjustment is in
325         effect for your location. This value should be a valid date in yyyym‐
326         mdd form
327
328       DST-End
329         Specify  the  date  when daylight saving time adjustment period ends.
330         This value should be a valid date in yyyymmdd form
331
332   Display Settings
333       HourFormat
334         Specify a time format for displaying  the  prayer  times.  The  value
335         should be 12 (regular time) or 24 (military time)
336

ENVIRONMENT

338       IPT_DATA  One  means  to  pass-in  the various required settings is via
339                 this variable.  The format of the variable needs to be "Loca‐
340                 tionName  Latitude  Longitude UTCdiff AngleMethodNumber". For
341                 instance,
342                 setenv IPT_DATA "Dubai 25.25 55.3 4 2"
343

FILES

345       ~/.iprayrc User configuration file.
346

EXAMPLES

348       A sample (~/.iprayrc) showing how options are set:
349
350           City: Brussels, Belguim
351           Latitude: 50.8333
352           Longitude: 4.3333
353           UTC: 1
354           AngleMethod: 2
355           Mathhab: 1
356           OffsetList: 0 0 1 2.21 3 -1
357
358       Examples of using the command line options:
359
360           ipraytime -y 2007
361
362           ipraytime -lat 29.5000 -lon 47.7500 -u 3 --anglemethod 2 -d 20071229 -h12
363
364

REPORTING BUGS

366       Report bugs on the web using http://bugs.arabeyes.org
367

AUTHORS

369       Written by Nadim Shaikli and Thamer Mahmoud. Part of  the  Arabeyes.org
370       project.
371
373       ipraytime is subject to the GNU General Public License (GPL).
374       Copyright © 2005, Arabeyes, Nadim Shaikli.
375

SEE ALSO

377       The  ITL library (libitl) from the Islamic Tools and Libraries project.
378       It is the underlying requirement for ipraytime to  function.   The  ITL
379       library was created and is hosted at www.arabeyes.org.
380
381
382
383ipraytime                       March 17, 2009                    IPRAYTIME(1)
Impressum