Add man page

develop
Damien Goutte-Gattat 10 years ago
parent a54841cfa0
commit 1162c581ac
  1. 2
      Makefile.am
  2. 2
      configure.ac
  3. 60
      wait4.1.in

@ -2,4 +2,6 @@ SUBDIRS = lib src
ACLOCAL_AMFLAGS = -I m4 --install
man_MANS = wait4.1
dist_doc_DATA = AUTHORS COPYING NEWS README

@ -25,7 +25,7 @@ AC_CHECK_HEADERS([linux/netlink.h],
AM_CONDITIONAL([HAVE_NETLINK], [test x$ac_cv_header_linux_netlink_h = xyes])
dnl Output files
AC_CONFIG_FILES([Makefile lib/Makefile src/Makefile])
AC_CONFIG_FILES([Makefile wait4.1 lib/Makefile src/Makefile])
AC_OUTPUT
dnl Summary

@ -0,0 +1,60 @@
.TH WAIT 03/21/2013 "wait4 @PACKAGE_VERSION]" "wait4 Manual"
.SH NAME
wait4 \- Wait for arbitrary processes
.SH SYNOPSIS
.SY wait4
.RB [ \-h | --help ]
.RB [ \-v | --version ]
.RB [ \-t | --timeout
.IR time ]
.IR pid ...
.YS
.SH DESCRIPTION
.PP
.B wait4
waits for the process(es) identified by the specified PID(s)
to terminate, and reports the termination status of the
process whose PID is specified last.
.SH OPTIONS
.TP
.BR -h ", " --help
Display the help message.
.TP
.BR -v ", " --version
Display the version message.
.TP
.BR -t ", " --timeout " " \fItime\fR
Aborts waiting after the specified
.I time
(in seconds).
.SH NOTES
.PP
The ability to report the termination status of the waited
process depends on
.BR netlink (7).
On systems without netlink, a fallback
.BR kill (2)-based
mechanism is used, which does not allow to retrieve the
termination status; the exit status is then always 0.
.SH REPORTING BUGS
.PP
Report bugs to
.MT @PACKAGE_BUGREPORT@
Damien Goutte-Gattat
.ME .
.SH COPYRIGHT
.ad l
.PP
Copyright \(co 2013 Damien Goutte-Gattat
.PP
This program is released under the GNU General Public License.
See the COPYING file in the source distribution or
.UR http://www.gnu.org/licenses/gpl.html
.UE .
Loading…
Cancel
Save