From 628ef9ac5b77a08e1fef630a3663583e2128c416 Mon Sep 17 00:00:00 2001 From: Simon Ruderich Date: Sat, 17 May 2014 23:02:50 +0200 Subject: [PATCH] add man page --- .gitignore | 3 +++ Makefile.am | 2 +- configure.ac | 2 +- man/Makefile.am | 17 ++++++++++++++ man/man.conf | 10 ++++++++ man/wall-notify.txt | 57 +++++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 89 insertions(+), 2 deletions(-) create mode 100644 man/Makefile.am create mode 100644 man/man.conf create mode 100644 man/wall-notify.txt diff --git a/.gitignore b/.gitignore index 562b70b..caf945d 100644 --- a/.gitignore +++ b/.gitignore @@ -9,6 +9,9 @@ /config.log /config.status /configure +/man/Makefile +/man/Makefile.in +/man/wall-notify.1 /src/.deps/ /src/Makefile /src/Makefile.in diff --git a/Makefile.am b/Makefile.am index 26226b0..4947109 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,3 +1,3 @@ -SUBDIRS = src +SUBDIRS = src man ACLOCAL_AMFLAGS = -I m4 diff --git a/configure.ac b/configure.ac index 9f1efc3..f7380b8 100644 --- a/configure.ac +++ b/configure.ac @@ -80,7 +80,7 @@ if test -z "$disable_x11_support"; then CFLAGS="$X_CFLAGS $CFLAGS" fi -AC_CONFIG_FILES([Makefile src/Makefile]) +AC_CONFIG_FILES([Makefile src/Makefile man/Makefile]) AC_OUTPUT if test "x$ac_cv_header_utempter_h" != xyes; then diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..03d409f --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,17 @@ +dist_man1_MANS = wall-notify.1 +dist_noinst_DATA = wall-notify.txt + +DISTCLEANFILES = $(dist_man1_MANS) + + +ASCIIDOC = asciidoc +XMLTO = xmlto + +A2XML = $(ASCIIDOC) --backend=docbook --doctype=manpage \ + --conf-file=$(srcdir)/man.conf +XML2MAN = $(XMLTO) man + +.txt.1: + $(A2XML) -o $@.xml $< + $(XML2MAN) $@.xml + rm $@.xml diff --git a/man/man.conf b/man/man.conf new file mode 100644 index 0000000..a6d5079 --- /dev/null +++ b/man/man.conf @@ -0,0 +1,10 @@ +# Macro to display links to other man pages. Inspired by Git's linkgit:[] +# macro. +[macros] +(?su)[\\]?(?Pmanlink):(?P\S*?)\[(?P.*?)\]= + +[manlink-inlinemacro] + + {target} + {0} + diff --git a/man/wall-notify.txt b/man/wall-notify.txt new file mode 100644 index 0000000..e059204 --- /dev/null +++ b/man/wall-notify.txt @@ -0,0 +1,57 @@ +wall-notify(1) +============== + +NAME +---- + +wall-notify - receive wall messages and pass them to a notification program + + +SYNOPSIS +-------- + +*wall-notify* ['-X'] ['-m'] 'cmd' ['args'].. + + +DESCRIPTION +----------- + +*wall-notify* receives *wall* messages and passes them to the notification +program 'cmd' and its arguments via stdin. For each received message a new +instance of 'cmd' is created. + + +OPTIONS +------- + +*-X*:: + Quit when the current X session terminates. By default *wall-notify* keeps + running. This option is intended for `~/.xinitrc` to prevent stale + *wall-notify* processes when the user logs out. Requires a running X + server. + +*-m*:: + Receive messages from all users. Works similar to *mesg y*. By default + only messages from root are allowed. Be careful when using this option, it + might be abused by local users to send fake messages. + + +AUTHORS +------- + +Written by Simon Ruderich . + + +COPYRIGHT +--------- + +Copyright \(C) 2014 Simon Ruderich. Free software licensed under GPL version +3 or later. + + +SEE ALSO +-------- + +manlink:wall[1], manlink:utmp[5], manlink:shtudown[1] + +// vim: ft=asciidoc -- 2.43.2