.\" .UC 4
.TH "hcal" "1" "2013-01-01" "Linux" "libhdate"
.SH "NAME"
hcal \- displays a Hebrew / Gregorian calendar
.PP
.SH "SYNOPSIS"
.B hcal
[options] [coordinates [timezone]] [[mm] yyyy]
.TP
coordinates: \-l [NS]yy[.yyy] \-L [EW]xx[.xxx]
.RE
.RS 7
\-l [NS]yy[:mm[:ss]] \-L [EW]xx[:mm[:ss]]
.RE
.RS 7
timezone: \-z nn[( .nn | :mm )]
.PP
.SH "DESCRIPTION"
.B hcal
prints a calendar with both Gregorian and Hebrew dates for the
specified Gregorian month or, if no month is specified, for the
whole Gregorian year. If no arguments are given, it prints the
current month's calendar. Jewish holidays are annotated, and can
optionally be footnoted.
.B hcal
tries to be sunset-aware in order to correctly highlight the
current Hebrew date, and can also display Shabbat times and
parshiot. See the section LOCATION, below.
.PP
.B INPUTTING A HEBREW DATE:
If the year provided is greater than 3000,
.B hcal
will interpret the given date as a Hebrew date, and will display the calendar of the corresponding Gregorian month(s). Hebrew months are expected to be passed as numbers 1-12 for Tishrei - Elul; Adar I and Adar II are expected to be passed as months 13 and 14.
.PP
.SH "OPTIONS"
.TP 18
.B \-1 --one-month
over-ride config file setting if you had set option --three-month as a default there
.TP
.B \-3 --three-month
output previous/next months, side by side. requires 127 columns
.TP
.B \-b --bidi
output Hebrew information in Hebrew , in reverse
.RE
.RS 7
.B \ \ \ --visual
\ sequence
.P
.RE
.RS 7
.B \ \ \ --no-bidi
\ over-ride config file setting if you had set
.RE
.RS 7
.B \ \ \ --no-visual
\ option -bidi as a default there
.TP 18
.B \-c --colorize
output in calming, muted tones
.RE
.RS 7
.B \ \ \ --no-color
\ over-ride config file setting
.TP 18
.B \-d --diaspora
use diaspora reading and holidays. Only relevant if hcal is using location information indicating an Israeli timezone
.TP
.B \-f --footnote
output descriptive notes of holidays
.RE
.RS 7
.B \ \ \ --no-footnote
\ over-ride config file setting
.TP 18
.B \-h --html
output in html format to stdout
.RE
.RS 7
.B \ \ \ --no-html
\ over-ride config file setting
.TP 18
.B \-H --hebrew
output Hebrew information in Hebrew, in 'logical' sequence. If this displays in reverse for you, use option \-b
.TP
.B \-I --israel
override a diaspora default. Only relevant if hcal is using location information indicating other than an Israeli timezone
.TP
.B \-i
use external css file "./hcal.css" for html output
.TP
.B \ \ \ \--no-reverse
do not highlight today's date
.TP
.B \-p --parasha
output week's parasha on each calendar row
.TP
.B \-s --shabbat
output Shabbat times and parshiot
.TP
.B \-l --latitude
[NS]yy[.yyy] decimal degrees, or [NS]yy[:mm[:ss]] degrees, minutes, seconds. Negative values are South
.TP
.B \-L --longitude
[EW]xx[.xxx] decimal degrees, or [EW]xx[:mm[:ss]] degrees, minutes, seconds. Negative values are West
.TP
.B \-z --timezone
\+/-UTC. Notation may be in decimal hours ( hh[.hh] ) or hours, minutes ( hh[:mm] )
.SH NOTES
.SS "HOLIDAYS"
.PP
Holidays are depicted by a change in the symbol separating a day's
Gregorian and Hebrew dates, as follows:
.P
.RS
.B /
\ Regular day
.RE
.RS
.B +
\ Yom Tov (plus Yom Kippur)
.RE
.RS
.B *
\ Erev Yom Kippur
.RE
.RS
.B ~
\ Hol HaMoed
.RE
.RS
.B !
\ Hanuka and Purim
.RE
.RS
.B @
\ Tzomot
.RE
.RS
.B $
\ Lag BaOmer ,Tu BeAv, Tu BeShvat
.RE
.RS
.B #
\ Independance day and Yom Yerushalaim
.RE
.RS
.B %
\ Tzahal and Holocaust memorial days
.RE
.RS
.B ^
\ Other Israeli National days
.RE
.P
Use the \-f (--footnote) option to have hcal describe what any particular day is marking.
.SS LOCATIONS
If you want
.B hcal
to display accurate Shabbat times, and to accurately advance the Hebrew 'today's date' indicator at sunset,
.B hcal
requires location and time zone information in order to make astronomical calculations for a given date. If you don't provide ANY such information,
.B hcal
uses your computer's local time zone information as an indicator, and either picks a city in that time zone, or defaults to the equator at the center of that time zone. If
.B hcal
can't even retrieve time zone information from your computer, it defaults to Tel-Aviv. For other locations, use the
.B \-l \-L
option pair. For other timezones, use the
.B \-z
option. Co-ordinates and standard time zones for some common locations are listed below.
.PP
The current defaults include:
.RS 9
Timezone Default city Lattitude Longitude
.RE
.RS 12
-5 New York City 40 \-74
.RE
.RS 12
0 London 51 0
.RE
.RS 12
1 Paris 48 2
.RE
.RS 12
2 Tel-Aviv 32 34
.RE
.RS 12
3 Moscow 55 37
.RE
.PP
Useful locations and time zones
.RS 6
Jerusalem 31, 35, 2 Buenos Aires 34, -58, -3
.RE
.RS 6
Tel Aviv 32, 34, 2 Hong Kong 22, 114, 8
.RE
.RS 6
Haifa 32, 34, 2 Los Angeles 34, -118, -8
.RE
.RS 6
Beer Sheva 31, 34, 2 Sao Paolo 23, -46, -3
.RE
.RS 6
Ashdod 31, 34, 2 Toronto 43, -79 -5
.RS 6
.RE
Tiberias 32, 35, 2
.RS 6
.RE
Eilat 29, 34, 2
.SH FILES
.SS CONFIG FILE
This folder and file will be automatically created, and
includes its own documentation, in-line:
.RS 16
.I ${XDG_CONFIG_HOME}/hcal/hcalrc
.P
.RE
If ${XDG_CONFIG_HOME} is undefined:
.RS 16
.I ~/.config/hcal/hcalrc
.SH "BUGS"
.TP 10
.B Accuracy
The accuracy of the astronomically-derived data will suffer from not accounting for environmental conditions such as elevation, horizon, temperature and air pressure.
.RE
.TP 10
.B Timezones
The timezone support is currenlty primitive and lacks support for daylight savings time transitions.
.RE
.TP 10
.B Historical
The software does not yet account for the phenomenon and complications of the "Gregorian transition" from the prior, Julian calendar, which effectively caused an instantaneous 'loss' of two weeks for all gentiles affected. Countries (eg. Poland, Spain and Italy) began adopting the Gregorian calendar on 8 Tishrei 5343 (4 October 1582CE), although many did not transition until the 56th century (1752 CE, eg. UK colonies, Sweden). Russia did not adopt the Gregorian calendar until 5678 (1918 CE) and Turkey did not until 5687 (December, 1926 CE). Many other countries made the transition on other dates. Keep in mind that Russia invaded part of Poland, undoing, for the interim, the Gregorian transition for (only) that part of Poland; Also important to remember in this regard is that Eretz Ysroel was part of the Turkish Ottoman empire until the British mandate (5677 (1917CE)). Until all this is accounted for adequately by this application, refer to '
.B ncal \-p
\' for a basic table of country transitions. However, keep in mind that European borders underwent many changes during the 426 years in question, so the accuracy of your data will depend on accurate knowledge of whether any particular date at any specific location was Julian or Gregorian.
.SH "EXAMPLES"
.TP 3
1. Display a 2012ce year's calendar, three-months wide, in color.
.RS 6
.B hcal \-3c 2012
.RE
.HP 3
2. Display the current month's calendar, with Shabbat times, parshiot, footnoted holiday identification, with Hebrew information in Hebrew, and all in "calming", "muted" color-tones.
.RS 6
.B hcal \-csfH
.SH "SEE ALSO"
mlterm(1), hdate(1), hebcal(1), date(1), ncal(1), cal(1), remind(1)
.SH "AUTHORS"
.RS 0
Boruch Baum 2011-2013, Yaacov Zamir 2005-2010.
.PP
project home page: http://libhdate.sourceforge.net
.PP
.B Hcal
and
.B Hdate
are part of the package
.B libhdate
, a small C/C++ library for Hebrew dates, holidays, and reading
sequences (parashiot). It uses the source code from Amos Shapir's
"hdate" package, as fixed and patched by Nadav Har'El. The Torah
reading sequence tables were contributed by Zvi Har'El.