aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-11-10 00:11:05 +0100
committerMattias Andrée <maandree@operamail.com>2015-11-10 00:11:05 +0100
commit5c3092704568532701fee51286c32afe2d95bc02 (patch)
treea2d5a2809241724a169e7c1f80f36177011b09ab
parentinfo/ => doc/info/ (diff)
downloadsleep-until-5c3092704568532701fee51286c32afe2d95bc02.tar.gz
sleep-until-5c3092704568532701fee51286c32afe2d95bc02.tar.bz2
sleep-until-5c3092704568532701fee51286c32afe2d95bc02.tar.xz
add man page
Signed-off-by: Mattias Andrée <maandree@operamail.com>
-rw-r--r--Makefile12
-rw-r--r--doc/man/sleep-until.140
2 files changed, 50 insertions, 2 deletions
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 <http://www.gnu.org/licenses/>.
+.SH BUGS
+Please report bugs to https://github.com/maandree/sleep-until/issues or to
+maandree@member.fsf.org