From 52a57c35fe96d091543f952fadb1ab89e7138324 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Fri, 27 Nov 2015 23:00:39 +0100 Subject: add manpage MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- Makefile | 10 ++++++++-- doc/man/mongoclock.1 | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 2 deletions(-) create mode 100644 doc/man/mongoclock.1 diff --git a/Makefile b/Makefile index 6d0750b..e3358ab 100644 --- a/Makefile +++ b/Makefile @@ -102,7 +102,7 @@ bin/%.ps: doc/info/%.texinfo .PHONY: install -install: install-base install-info +install: install-base install-info install-man .PHONY: install-all install-all: install-base install-doc @@ -121,7 +121,7 @@ install-license: install -m644 COPYING -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" .PHONY: install-doc -install-doc: install-info install-pdf install-dvi install-ps +install-doc: install-info install-pdf install-dvi install-ps install-man .PHONY: install-info install-info: bin/mongoclock.info @@ -143,6 +143,11 @@ install-ps: bin/mongoclock.ps install -dm755 -- "$(DESTDIR)$(DOCDIR)" install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" +.PHONY: install-man +install-man: doc/man/mongoclock.1 + install -dm755 -- "$(DESTDIR)$(MAN1DIR)" + install -m644 $< -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1" + .PHONY: uninstall @@ -154,6 +159,7 @@ uninstall: -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" + -rm -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1" diff --git a/doc/man/mongoclock.1 b/doc/man/mongoclock.1 new file mode 100644 index 0000000..27c9a5d --- /dev/null +++ b/doc/man/mongoclock.1 @@ -0,0 +1,52 @@ +.TH MONGOCLOCK 1 MONGOCLOCK +.SH NAME +mongoclock - Just a humongous clock for the terminal +.SH SYNOPSIS +.BR mongoclock +.SH DESCRIPTION +Type +.BR mongoclock +in the terminal and it will either, depending on +the terminal size, show the time \fIHH:MM\fP or +\fIHH:MM:SS\fP with humongous digits. +.PP +If the terminal is too small, it will not run. +.PP +.BR mongoclock +is designed to be fit on most screens and be +readable from all practical distances, so that +it can be used in place of a standard wall- or +alarm-clock. If the font is not big enough for +your (or if it is too large,) just change the +font size on your terminal. If it is not the +right colour for you, simply change the font +colour on your terminal +.SH RATIONALE +It is really nice to have a large clock on your +computer, instead of a small clock somewhere in +your room, when your are sleeping. It is also +nice to have a glansable clock available on your +netbook for when you need to keep track of the +time but are not working on a computer. +Pocket-watches are just too much work to getting +up, opening, closing, and putting down, and you +would not like to forget it when you leave if +you are in a public place. +.SH "SEE ALSO" +.BR watch (1) +.PP +Full documentation available locally via: info \(aq(mongoclock)\(aq +.SH AUTHORS +Principal author, Mattias Andrée. See the COPYING file for the full +list of authors. +.SH LICENSE +Copyright \(co 2013, 2015 Mattias Andrée +.br +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +.br +There is NO WARRANTY, to the extent permitted by law. +.SH BUGS +Please report bugs to https://github.com/maandree/mongoclock/issues or to +maandree@member.fsf.org -- cgit v1.2.3-70-g09d2