]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
wdctl: add man page
authorKarel Zak <kzak@redhat.com>
Fri, 4 May 2012 09:04:35 +0000 (11:04 +0200)
committerKarel Zak <kzak@redhat.com>
Fri, 4 May 2012 09:04:35 +0000 (11:04 +0200)
Signed-off-by: Karel Zak <kzak@redhat.com>
sys-utils/Makefile.am
sys-utils/wdctl.8 [new file with mode: 0644]

index a1a914b9eb6fbfc33788a5412c3c2780c360d7f9..caceae2c419fed9a77752ec393c65d7c57f48bb6 100644 (file)
@@ -186,6 +186,7 @@ flock_SOURCES = flock.c $(top_srcdir)/lib/strutils.c
 ldattach_SOURCES = ldattach.c $(top_srcdir)/lib/strutils.c
 
 bin_PROGRAMS += wdctl
+dist_man_MANS += wdctl.8
 wdctl_SOURCES = \
        wdctl.c \
        $(top_srcdir)/lib/strutils.c \
diff --git a/sys-utils/wdctl.8 b/sys-utils/wdctl.8
new file mode 100644 (file)
index 0000000..3abe395
--- /dev/null
@@ -0,0 +1,50 @@
+.\" wdctl.8 --
+.\" Copyright (C) 2012 Karel Zak <kzak@redhat.com>
+.\" May be distributed under the GNU General Public License
+
+.TH WDCTL 8 "May 2012" "util-linux" "System Administration"
+.SH NAME
+wdctl \-
+show hardware watchdog status
+.SH SYNOPSIS
+.B wdctl
+.RB [options]
+
+.SH DESCRIPTION
+Show hardware watchdog status. Note that number of supported watchdog
+features is hardware specific.
+
+.SH OPTIONS
+.IP "\fB\-d, \-\-device \fIpath\fP"
+Device to use, default is /dev/watchdog.
+.IP "\fB\-f, \-\-flags \fI<list>\fP"
+Print selected flags only.
+.IP "\fB\-F, \-\-noflags\fP"
+Don't print information about flags
+.IP "\fB\-n, \-\-noheadings\fP"
+Do not print a header line.
+.IP "\fB\-I, \-\-noident\fP"
+Don't print watchdog identity information
+.IP "\fB\-T, \-\-notimeouts\fP"
+Don't print watchdog timeouts
+.IP "\fB\-o, \-\-output \fIlist\fP"
+Define the output columns to use in table of watchdog flags. If no output
+arrangement is specified, then a default set is used.  Use \fB\-\-help\fP to
+get list of all supported columns.
+.IP "\fB\-P, \-\-pairs\fP"
+Use key="value" output format.
+.IP "\fB\-V, \-\-version\fP"
+Output version information and exit.
+.IP "\fB\-r, \-\-raw\fP"
+Use the raw output format.
+.IP "\fB\-h, \-\-help\fP"
+Print a help text and exit.
+
+.SH AUTHORS
+.nf
+Karel Zak <kzak@redhat.com>
+Lennart Poettering <lennart@poettering.net>
+.fi
+.SH AVAILABILITY
+The wdctl command is part of the util-linux package and is available from
+ftp://ftp.kernel.org/pub/linux/utils/util-linux/.