next-prayer.1

.TH "NEXT-PRAYER" "1" "2022 Mar 26" next-prayer-VERSION

.SH NAME
next-prayer \- Next Islamic prayer.

.SH SYNOPSIS
.B next-prayer
.RB [ \-\-next ]
.nf
.fi
.B next-prayer
.RB [ \-\-prev ]
.nf
.fi
.B next-prayer
.RB [ \-\-hybrid ]
.nf
.fi
.B next-prayer
.RB [ \-\-all ]
.nf
.fi
.B next-prayer
.RB [ \-\-elapsed ]
.nf
.fi
.B next-prayer
.RB [ \-\-left ]
.nf
.fi
.B next-prayer
.RB [ \-\-adhan ]
.nf
.fi
.B next-prayer
.RB [ \-\-hijri ]
.nf
.fi
.B next-prayer
.RB [ \-\-version ]
.nf
.fi
.B next-prayer
.RB [ \-\-help ]


.SH DESCRIBTION
.B
next-prayer
Islamic prayers reminder for status bars.

.SH OPTIONS
.TP
.BR \-\-next
The next prayer and its time.
.TP
.BR \-\-prev
The previous prayer and its time.
.TP
.BR \-\-hybrid
The elapsed time since the previous prayer as far as the elapsed time <= THRESHOLD.
.TP
.BR \-\-all
Show all timings.
.TP
.BR \-\-elapsed
The time elapsed since the previous prayer.
.TP
.BR \-\-left
The time left until the next prayer.
.TP
.BR \-\-adhan
Whether the current time is adhan or not.
.TP
.BR \-\-hijri
The current hijri date.
.TP
.BR \-\-version
Display the version.
.TP
.BR \-\-help
Display this help message.

.SH
FILES
.TP
.I $HOME/.local/bin/next-prayer
The executable file.
.TP
.I $HOME/.local/bin/np_fetch.py
Run manually each time you update the config file.
.TP
.I $HOME/.config/next-prayer/np_config.py
The config file.
.nf

.I parameters:
.B "latitude" \fR(decimal)
The decimal value for the latitude co-ordinate of the location you want the time computed for. Example: 51.75865125
If not specified, it defaults to \fICairo.

.B "longitude" \fR(decimal)
The decimal value for the longitude co-ordinate of the location you want the time computed for. Example: -1.25387785
If not specified, it defaults to \fICairo.

.B "method" \fR(number)
A prayer times calculation method. Methods identify various schools of thought about how to compute the timings.
If not specified, it defaults to \fI5 - Egyptian General Authority of Survey.
\fRThis parameter accepts values from 0-12 and 99, as specified below:

0 - Shia Ithna-Ansari
1 - University of Islamic Sciences, Karachi
2 - Islamic Society of North America
3 - Muslim World League
4 - Umm Al-Qura University, Makkah
5 - Egyptian General Authority of Survey
7 - Institute of Geophysics, University of Tehran
8 - Gulf Region
9 - Kuwait
10 - Qatar
11 - Majlis Ugama Islam Singapura, Singapore
12 - Union Organization islamic de France
13 - Diyanet İşleri Başkanlığı, Turkey
14 - Spiritual Administration of Muslims of Russia
15 - Moonsighting Committee Worldwide (also requires shafaq paramteer)
99 - Custom. See https://aladhan.com/calculation-methods

.B "adjustment" \fR(number)
Number of days to adjust hijri date(s). Example: 1 or 2 or -1 or -2

.B "annual" \fR(boolean)
If true, we'll ignore the month and return the calendar for the whole year.

.B "year" \fR(number)
A gregorian calendar year. Example: 2014.
If not specified, it defaults to is the current year.

.B "threshold" \fR(hh:mm)
A threshold time in the form of \fB"hh:mm" \fRthat whenever the elapsed time reach it, It will show up the next prayer,
instead of the elapsed time. this applicable only when you use \fB\-\-hybrid \fRflag.
\fBtemporarily moved to the executable file\fR.

.SH CUSTOMIZATION
next-prayer can be customized by editing the \fBconfig file\fR at \fI$HOME/.config/next-prayer/np_config.py \fRand run the \fI'python3 np_fetch.py' \fRcommand.

.SH AUTHOR
Abd El-Twab M. Fakhry <\fIabdeltwab.m.fakhry@gmail.com\fR>

.SH LICENSE
See the LICENSE file for the terms of redistribution.

.SH BUGS
Consider reporting bugs via opening an issue here (https://github.com/abdeltwabmf/next-prayer/issues).