Skip to content

MosheBerman/hebcal

 
 

Repository files navigation

hebcal Build Status

A perpetual Jewish Calendar

by Danny Sadinoff
portions by Michael J. Radwin

Description

Hebcal is a program which prints out the days in the Jewish calendar for a given gregorian year. Hebcal is fairly flexible in terms of which events in the Jewish calendar it displays. Each of the following can be individualy turned on or off:

  • The Hebrew date
  • Jewish Holidays (including Yom Ha'atzmaut and Yom HaShoah etc.)
  • The weekly Sedrah
  • The day of the week
  • The days of the Omer

Synopsis

usage: hebcal [-8acdDeFHhiorsStTwy]
            [-b candle_lighting_minutes_before_sundown ]
            [-I file]
            [-Y yahrtzeit_file]
            [-C city]
            [-L longitude -l latitude]
            [-m havdalah_minutes_past_sundown ]
            [-z timezone]
            [-Z daylight_savings_option]
            [-f format_option]
            [[ month [ day ]] year ]
       hebcal help
       hebcal info
       hebcal DST
       hebcal cities
       hebcal warranty
       hebcal copying

Hebcal prints out Hebrew calendars one solar year at a time. Given one argument, it will print out the calendar for that year. Given two numeric arguments mm yyyy, it prints out the calendar for month mm of year yyyy.

For example, hebcal -ho will just print out the days of the omer for the current year. Note: Use COMPLETE Years. You probably aren't interested in hebcal 93, but rather hebcal 1993.

Options

Option Description
-8 Use 8-bit Hebrew (ISO-8859-8-Logical).
-a Use ashkenazis hebrew.
-b mins Set candle-lighting to occur this many minutes before sundown
-c Print candlelighting times.
-C city Set latitude, longitude, timezone and daylight savings scheme according to specified city. This option implies the -c option.
-d print the hebrew date for the entire date range.
-D print the hebrew date for dates with some event.
-e Ouput "European" dates -- DD.MM.YYYY format.
-f FORMAT change output to FORMAT. see below for format strings
-F Output the Daf Yomi for the entire date range.
-h Suppress default holidays.
-H Use Hebrew date ranges - only needed when e.g. hebcal -H 5373
-i Use Israeli sedra scheme.
-I file Get non-yahrtzeit Hebrew user events from specified file. The format is: mmm dd string, Where mmm is a Hebrew month name.
-l xx,yy Set the latitude for solar calculations to xx degrees and yy minutes. Negative values are south.
-L xx,yy Set the longitude for solar calculations to xx degrees and yy minutes. Negative values are EAST. The -l and -L switches must both be used, or not at all. These switches override the -C (localize to city) switch.
-m mins Set havdalah to occur this many minutes after sundown
-M Print the molad on shabbat mevorchim.
-o Add days of the omer.
-O Output sunrise and sunset times every day.
-r Tab delineated format.
-s Add weekly sedrot on saturday.
-S Print sedrah of the week on all calendar days.
-t Only output for today's date.
-T Print today's pertinent information, no gregorian date.
-w Add day of the week.
-x Suppress Rosh Chodesh.
-y Print only last two digits of year.
-Y file Get yahrtzeit dates from specified file. The format is: mm dd yyyy string. The first three fields specify a Gregorian date.
-z Use specified timezone, disabling daylight savings time, overriding the -C (localize to city) switch.
-Z scheme change to daylight savings scheme. The possible values of scheme are currently usa, israel, eu, and none.

Candle-lighting times

Hebcal’s candlelighting times are only approximations. If you ever have any doubts about it’s times, consult your local halachic authority. If you enter geographic coordinates above the artic circle or antarctic circle, the times are guaranteed to be wrong.

Hebcal contains a small database of cities with their associated geographic information and time-zone information. The geographic and time information necessary to calculate sundown times can come to hebcal any of three ways:

  1. The default: the system manager sets a default city when the program is compiled.
  2. Hebcal looks in the environment variable HEBCAL_CITY for the name of a city in hebcal’s database, and if it finds one, hebcal will make that the new default city.
  3. 1 and 2 may be overridden by command line arguments, including those specified in the HEBCAL_OPTS environment variable. The most natural way to do this is to use the −c city command. This will localize hebcal to city. A list of the cities hebcal knows about can be obtained by typing hebcal cities at the command prompt. If the city you want isn’t on that list, you can directly control hebcal’s geographic information with the −l, −L −z and −Z DST switches. Note that changing the geographic coordinates causes the timezone to default to Zulu and the daylight savings time processor to default to ’none.’ To get a list of possible values for DST, type hebcal DST at the command prompt. For a status report on customizations, type hebcal info at the command prompt.

Environment

Hebcal uses two environment variables:

HEBCAL_CITY
Hebcal uses this value as the default city for sunset calculations. A list of available cities is available with from hebcal with the command: hebcal cities
HEBCAL_OPTS
The value of this variable is automatically processed as if it were typed at the command line before any other actual command−line−arguments.

Author

Danny Sadinoff

See Also

calendar(1), emacs(1), hcal(1), hdate(1), omer(1), remind(1), rise(1)

The latest version of the code will be available from https://github.com/hebcal/hebcal

The original motivation for the algorithms in this program was the Tur Shulchan Aruch.

For version 3, much of the program was rewritten using Emacs 19’s calendar routines by Edward M. Reingold and Nachum Dershowitz. Their program is extremely clear and provides many instructive examples of fine calendar code in emacs-LISP.

A well written treatment of the Jewish calendar for the layman can be found in Understanding the Jewish Calendar by Rabbi Nathan Bushwick. A more complete bibliography on the topic can be found there, as well as in the Encyclopedia Judaica entry on the calendar.

Diagnostics

hebcal help
Prints a shorter version of this manpage, with comments on each option.
hebcal info
Prints the version number and default values of the program.
hebcal DST
Prints a list of available daylight savings time schemes, suitable as arguments to the −Z DST option.
hebcal cities
Prints a list of cities which hebcal knows about, suitable as arguments to the −C city option. If your city does not appear on this list, put the necessary defaults in the DST_OPTS environment variable.
hebcal copying
Prints the GNU license, with information about copying the program. See below.
hebcal warranty
Tells you how there’s NO WARRANTY for hebcal.

Disclaimer

This is just a program I wrote during summer school and while avoiding my senior project. It should not be invested with any sort of halachic authority.

Bugs

Hebrew dates are only valid before sundown on that secular date. An option to control this will be added in a later release.

Negative longitudes are EAST of Greenwich.

Some combinations of options produce weird results, e.g. hebcal -dH nisan 5744 hebcal -dH 5744 This comes into play when you use the HEBCAL_OPTS environment variable.

The sunup/sundown routines aren’t accurate enough. If you enter geographic coordinates above the artic circle or antarctic circle, the times are guaranteed to be wrong.

Hebcal only translates between the Gregorian calendar and the Jewish calendar. This means that the results will be at least partly useless where and when the Gregorian calendar was not used, e.g. before the 1752 in Britain and before circa 1918 in Russia. See "Daylight saving time" on Wikipedia for a splendid chart depicting when the changeover from the Julian to the Gregorian calendars occurred in various places.

Hebcal cannot handle date computations before 2 C.E. sorry.

Daylight-Savings time rules are as up-to-date as a nonpaying job allows. US DST rules are correct only back to 1966.

Hebcal assumes that the Energy Policy Act of 2005, which changes the DST rules in the US will go into effect, even though Congress may still revert it.

DISTRIBUTION

Copyright (C) 1994-2011 Danny Sadinoff
Portions Copyright (c) 2011 Michael J. Radwin. All Rights Reserved.

Hebcal is distributed under the GNU Public License. The program and its source code may be freely distributed. For details, see the file COPYING in the distribution.

If you are going to use this program, please drop me a line. I'd like to know who you are, what version you're using, and how you're using hebcal, and anything else you'd like to tell me, so that I can adjust the program to meet users' needs.

I am NOT demanding payment for the use of my program, but writing this program DID take time. The "free" in the GNU public license refers to distribution, not necessarily payment. Feel free to send $10 or multiples of $18 or just a postcard to me at my US Mail address (email me for it).

  send email to:
  danny@sadinoff.com

About

A perpetual Jewish Calendar

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C 83.7%
  • Shell 16.3%