From 5c3092704568532701fee51286c32afe2d95bc02 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Tue, 10 Nov 2015 00:11:05 +0100 Subject: add man page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- Makefile | 12 ++++++++++-- doc/man/sleep-until.1 | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+), 2 deletions(-) create mode 100644 doc/man/sleep-until.1 diff --git a/Makefile b/Makefile index f6088cd..d1ac213 100644 --- a/Makefile +++ b/Makefile @@ -18,6 +18,8 @@ DATADIR = $(PREFIX)$(DATA) DOCDIR = $(DATADIR)/doc # The info manual documentation path including prefix INFODIR = $(DATADIR)/info +# The man page documentation path including prefix +MANDIR = $(DATADIR)/man # The license base path including prefix. LICENSEDIR = $(DATADIR)/licenses @@ -101,7 +103,7 @@ bin/%.ps: doc/info/%.texinfo doc/info/fdl.texinfo # Install rules. .PHONY: install -install: install-base install-info +install: install-base install-info install-man .PHONY: install install-all: install-base install-doc @@ -132,7 +134,7 @@ install-license: # Install documentation. .PHONY: install-doc -install-doc: install-info install-pdf install-ps install-dvi +install-doc: install-info install-pdf install-ps install-dvi install-man .PHONY: install-info install-info: bin/sleep-until.info @@ -154,6 +156,11 @@ install-dvi: bin/sleep-until.dvi install -dm755 -- "$(DESTDIR)$(DOCDIR)" install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" +.PHONY: install-man +install-man: + install -dm755 -- "$(DESTDIR)$(MANDIR)/man1" + install -m644 doc/man/sleep-until.1 -- "$(DESTDIR)$(MANDIR)/man1/$(COMMAND).1" + # Uninstall rules. @@ -167,6 +174,7 @@ uninstall: -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" + -rm -- "$(DESTDIR)$(MANDIR)/man1/$(COMMAND).1" # Clean rules. diff --git a/doc/man/sleep-until.1 b/doc/man/sleep-until.1 new file mode 100644 index 0000000..7567eb4 --- /dev/null +++ b/doc/man/sleep-until.1 @@ -0,0 +1,40 @@ +.TH SLEEP-UNTIL 1 +.SH NAME +sleep-until - sleeps until a specified time +.SH SYNOPSIS +.B sleep-until +.IR timepoint ... +.SH DESCRIPTION +Pause until \fItimepoint\fP. \fItimepoint\fP is the number of +seconds since Epoch, in UTC but not accounting for leap seconds. +\fItimepoint\fP may be an arbitrary floating point number. +Pause is continued when interrupted. +.SH EXIT STATUS +.TP +0 +The command was successful. +.TP +1 +The command failed. +.SH SEE ALSO +.BR sleep (1), +.BR date (1) +.SH AUTHORS +Principal author, Mattias Andrée. See the COPYING file for the full +list of authors. +.SH COPYRIGHT +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU Affero General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.PP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU Affero General Public License for more details. +.PP +You should have received a copy of the GNU Affero General Public License +along with this program. If not, see . +.SH BUGS +Please report bugs to https://github.com/maandree/sleep-until/issues or to +maandree@member.fsf.org -- cgit v1.2.3-70-g09d2