Merge branch 'manpage'

wlopm.1

@@ -1,53 +1,76 @@
-.TH wlopm 1 2021-03-17 wlopm-0.0.1
+.TH WLOPM 1 2021-07-17 "git.sr.ht/~leon_plickat/wlopm" "General Commands Manual"
-
+.
 .SH NAME
-wlopm - Wayland output power management
-
-.SH DESCRIPTION
-wlopm is a simple client implementing zwlr-output-power-management-v1. If no
-operations are defined, wlopm will list all outputs and their current power
-modes.
-
-.SH USAGE
-\fB-h\fR, \fB--help\fR
-.RS 4
-Print help and exit.
 .P
+wlopm \- Wayland output power management
+.
+.
+.SH SYNOPSIS
+.SY wlopm
+.OP \-j
+.OP \-\-json
+.OP \-\-on output-name
+.OP \-\-off output-name
+.OP \-\-toggle output-name
+.YS
+.
+.SY wlopm
+.OP \-h
+.OP \-\-help
+.SY
+.
+.
+.SH DESCRIPTION
+.P
+wlopm is a simple client implementing \fBzwlr-output-power-management-v1\fR.
+.P
+If no operations are defined, wlopm will list all outputs and their current
+power modes.
+.
+.
+.SH OPTIONS
+.P
+\fB-h\fR, \fB--help\fR
+.RS
+Print help and exit.
 .RE
-
+.
+.P
 \fB-j\fR, \fB--json\fR
-.RS 4
+.RS
 Enable JSON formatting for listing outputs and errors encountered while trying
 to set their power modes.
-.P
 .RE
-
+.
-\fB--on\fR <output-name>
+.P
-.RS 4
+\fB--on\fR \fIoutput-name\fR
+.RS
 Set the power mode of the output to on.
-.P
 .RE
-
+.
-\fB--off\fR <output-name>
+.P
-.RS 4
+\fB--off\fR \fIoutput-name\fR
+.RS
 Set the power mode of the output to off.
-.P
 .RE
-
+.
-\fB--toggle\fR <output-name>
-.RS 4
-Toggle the power mode of the output.
 .P
+\fB--toggle\fR \fIoutput-name\fR
+.RS
+Toggle the power mode of the output
 .RE
-
+.
-
+.
 .SH OUTPUT NAMES
+.P
 Output names are compositor dependand.
 .P
-If instead of an output name * is given as parameter to an operation, wlopm will
+If instead of an output name \fB*\fR is given as parameter to an operation,
-do that operation for all discovered outputs.
+wlopm will do the operation for all discovered outputs.
-
+.
-
+.
 .SH AUTHOR
+.P
+.MT leonhenrik.plickat@stud.uni-goettingen.de
 Leon Henrik Plickat
-
+.ME