Add manpages for ratbagctl and ratbagd

Signed-off-by: Stephen Kitt <steve@sk2.org>
This commit is contained in:
Stephen Kitt
2016-09-18 23:30:46 +02:00
committed by bentiss
parent a9dc630fae
commit fc874c0249
3 changed files with 100 additions and 0 deletions

View File

@@ -27,6 +27,8 @@ lib_LTLIBRARIES =
noinst_LTLIBRARIES =
bin_PROGRAMS =
noinst_PROGRAMS =
dist_man1_MANS =
dist_man8_MANS =
AM_CPPFLAGS = \
-include $(top_builddir)/config.h \
@@ -80,6 +82,8 @@ ratbagd_LDADD = \
$(LIBSYSTEMD_LIBS) \
$(LIBRATBAG_LIBS)
dist_man8_MANS += doc/ratbagd.8
# ------------------------------------------------------------------------------
# DBus and systemd configuration files
@@ -119,3 +123,5 @@ python/ratbagctl: python/ratbagctl.py
EXTRA_DIST += python/ratbagctl.py
BUILT_SOURCES += python/ratbagctl
dist_man1_MANS += doc/ratbagctl.1

75
doc/ratbagctl.1 Normal file
View File

@@ -0,0 +1,75 @@
.TH ratbagctl 1 "Apr 13, 2016" ratbagctl
.SH NAME
ratbagctl \- inspect and modify configurable mice
.SH SYNOPSIS
.B ratbagctl
.RB [ \-h ]
.RB [ \-V ]
.br
.B ratbagctl list-devices
.br
.B ratbagctl show-device
.RI < device >
.br
.B ratbagctl show-profile
.RI < device "> <" profile >
.br
.B ratbagctl show-resolution
.RI < device "> <" profile "> <" resolution >
.br
.B ratbagctl show-button
.RI < device "> <" profile "> <" button >
.SH DESCRIPTION
.SS Common options
.TP
.BR \-h
displays a short help message (it can be used with any form of the
.B ratbagctl
command).
.TP
.BR \-V
displays the version of
.B ratbagctl
and exits.
.SS Listing devices
.TP
.B list-devices
lists all identified devices on the system.
.SS Displaying a device
.TP
.BR show-device " <" \fIdevice\fP >
displays the device information for the given
.I device
(as identified by
.BR list-devices ).
.SS Displaying profiles
.TP
.IR \fBshow-profile\fP " <" device "> <" profile >
displays the profile information for the given
.I device
and
.IR "profile index" .
.SS Displaying resolution information
.TP
.IR \fBshow-resolution\fP " <" device "> <" profile "> <" resolution >
displays the resolution information for the given
.IR device ,
.IR "profile index" ,
and
.IR "resolution index" .
.SS Displaying button information
.TP
.IR \fBshow-button\fP " <" device "> <" profile "> <" button >
displays the resolution information for the given
.IR device ,
.IR "profile index" ,
and
.IR "button index" .
.SH SEE ALSO
.BR ratbagd (8)
.SH AUTHORS
.B ratbagctl
was written by David Herrmann, Peter Hutterer and Benjamin Tissoires.
.PP
This manual page was written by Stephen Kitt <skitt@debian.org> for
the Debian GNU/Linux system (but may be used by others).

19
doc/ratbagd.8 Normal file
View File

@@ -0,0 +1,19 @@
.TH ratbagd 8 "Apr 13, 2016" ratbagd
.SH NAME
ratbagd \- system daemon to introspect and modify configurable mice
.SH SYNOPSIS
.B ratbagd
.RB [ \-\-verbose ]
.SH DESCRIPTION
.B ratbagd
starts the daemon. It shouldn't be invoked directly;
.B ratbagd
is normally started through DBus activation.
.SH SEE ALSO
.BR ratbagctl (1)
.SH AUTHORS
.B ratbagd
was written by David Herrmann, Peter Hutterer and Benjamin Tissoires.
.PP
This manual page was written by Stephen Kitt <skitt@debian.org> for
the Debian GNU/Linux system (but may be used by others).