diff --git a/Makefile.am b/Makefile.am index 4eb56c1..21cb7eb 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,3 +1,5 @@ SUBDIRS = src dist_doc_DATA = README + +man_MANS = man/sun.1 diff --git a/man/sun.1 b/man/sun.1 new file mode 100644 index 0000000..66bbb81 --- /dev/null +++ b/man/sun.1 @@ -0,0 +1,83 @@ +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.10. +.TH SUN "1" "December 2012" "sun 0.1" "User Commands" +.SH NAME +sun \- calculate sun's rise/set times, the solar noon and the daylight time duration +.SH SYNOPSIS +\fBsun\fP \fImode\fP [options] +.SH DESCRIPTION +\fBsun\fP is designed to be used with tools like \fBcron\fP, \fBat\fP etc.. +Take a look at the EXAMPLE section for some useful usecases. +.TP +\fImode\fR is one of: +.IP +\fBrise\fP calculate sunrise +.IP +\fBset\fP calculate sunset +.IP +\fBnoon\fP calculate solar noon +.IP +\fBdaytime\fP calculate daylight time duration +.IP +\fBnighttime\fP calculate 24h - daytime + +.P +Please note that a combination of \fB\-\-lat\fR, \fB\-\-lon\fR or \fB\-\-query\fR is required! + +.SH OPTIONS +.TP +\fB\-t\fR, \fB\-\-twilight\fR=\fITWILIGHT\fP +use special twilight. + +\fBcivil\fR: -6 degrees + +\fBnautic\fR: -12 degrees + +\fBastro\fR: -18 degrees + +.TP +\fB\-d\fR, \fB\-\-date\fR=\f%Y-%m-%d\fP +calculcate for specified date (eg. 2011\-12\-25) +.TP +\fB\-f\fR, \fB\-\-format\fR=\fIFORMAT\fP +output format (eg. %H:%M:%S). For valid formatstrings look at \fBstrftime\fP(3). +.TP +\fB\-a\fR, \fB\-\-lat\fR=\fI\-90..90\fP +geographical latitude in degrees +.TP +\fB\-o\fR, \fB\-\-lon\fR=\fI\-180..180\fP +geographical longitude in degrees +.TP +\fB\-q\fR, \fB\-\-query\fR=\fINAME\fP +query geonames.org for geographical position +.TP +\fB\-z\fR, \fB\-\-zone\fR=\fIINTEGER\fP +use timezone for output. Defaults to system-wide timezone defined in \fI/etc/timezone\fP or in environment variable TZ. +.TP +\fB\-h\fR, \fB\-\-help\fR +show this help +.TP +\fB\-v\fR, \fB\-\-version\fR +show version + +.SH EXAMPLES +.TP +.B echo "~/bin/enable-lightning" | at $(sun set -q Frankfurt -t civil) +enable lightning at sunset in Frankfurt + +.TP +.B shutdown $(date -d "+10min $(src/sun noon --lat=50.55 --lon=-6.2)" +%H:%M) +shutdown system 10 minutes after solar noon in Berlin + +.TP +.B nvram-wakeup -s $(date -d "-10min $(sun rise -q Aachen)" +%s) +start system 10 minutes before sunrise in Aachen + + +.SH "SEE ALSO" +.BR at (1) +.BR cron (1) +.BR nvram-wakeup (1) +.SH AUTHOR +Steffen Vogel +.SH BUGS +Please report bugs to: post@steffenvogel.de