docs: add manpages
This commit is contained in:
parent
65564de9d2
commit
2f063145c7
|
@ -0,0 +1,36 @@
|
|||
.TH GPOWER2 1 "2022\-09\-27"
|
||||
.SH NAME
|
||||
\fBgpower2\fP \- GTK4 Power dialog written in zig
|
||||
|
||||
.SH SYNOPSIS
|
||||
\fBgpower2\fP
|
||||
|
||||
.SH DESCRIPTION
|
||||
\fBgpower2\fP will open a power dialog using the GTK4 GUI framework.
|
||||
|
||||
.SS Buttons
|
||||
There are 4 buttons that are used for different power operations respectively:
|
||||
.TP
|
||||
.B Shutdown
|
||||
Power off the machine.
|
||||
|
||||
.TP
|
||||
.B Reboot
|
||||
Reboot the machine.
|
||||
|
||||
.TP
|
||||
.B Suspend
|
||||
Suspend (sleep) the machine.
|
||||
|
||||
.TP
|
||||
.B Hibernate
|
||||
Hibernate the machine. Note that this almost always requires additional configuration, such as kernel parameteres to restore the state and configuration for saving it prior to shutdown.
|
||||
|
||||
.SS Icons
|
||||
\fBgpower2\fP uses non-standard GTK icons for its 4 buttons. These icons currently are \fIsystem-shutdown\fP, \fIsystem-reboot\fP, \fIsystem-suspend\fP and \fIsystem-hibernate\fP. You'll have to provide these using your own icon theme.
|
||||
|
||||
.SH FILES
|
||||
\fI$XDG_CONFIG_HOME/gpower2/config.init\fP is used to configure \fBgpower2\fP. See \fBgpower2\fP(5) for more details.
|
||||
|
||||
.SH SEE ALSO
|
||||
\fBgpower2\fP(5)
|
|
@ -0,0 +1,49 @@
|
|||
.TH GPOWER2 5 "2022\-09\-27"
|
||||
.SH NAME
|
||||
gpower2 \- gpower2 configuration file
|
||||
|
||||
.SH SYNOPSIS
|
||||
$XDG_CONFIG_HOME/gpower2/config.ini, $HOME/.config/gpower2/config.ini
|
||||
|
||||
.SH DESCRIPTION
|
||||
This file allows the user to configure the \fBgpower2\fP power dialog.
|
||||
|
||||
It has a \fI.ini\fP format.
|
||||
|
||||
Currently, the only available settings are the commands to run when the 4 buttons in gpower2 are clicked.
|
||||
|
||||
.SH OPTIONS
|
||||
The only section currently available is \fB[commands]\fP. All of gpower2's settings should go under it.
|
||||
|
||||
All of the properties are optional and the defaults are used if not provided.
|
||||
|
||||
.SS Properties of the \fB[commands]\fP section
|
||||
.TP
|
||||
.B shutdown
|
||||
The command to execute when the shutdown button is clicked.
|
||||
|
||||
Default: \fIsystemctl poweroff\fP
|
||||
|
||||
.TP
|
||||
.B reboot
|
||||
The command to execute when the reboot button is clicked.
|
||||
|
||||
Default: \fIsystemctl reboot\fP
|
||||
|
||||
.TP
|
||||
.B suspend
|
||||
The command to execute when the suspend button is clicked.
|
||||
|
||||
Default: \fIsystemctl suspend\fP
|
||||
|
||||
.TP
|
||||
.B hibernate
|
||||
The command to execute when the hibernate button is clicked.
|
||||
|
||||
Default: \fIsystemctl hibernate\fP
|
||||
|
||||
.SS Command parsing
|
||||
\fBgpower2\fP parses commands simply by seperating spaces and using this as argv. An exception are double quotes and single quotes as well as backslash-escaping. Essentially, use posix shell syntax without any of the fancy bits. If you need to run a more complex command invoke the shell of your choice.
|
||||
|
||||
.SH SEE ALSO
|
||||
\fBgpower2\fP(1)
|
Loading…
Reference in New Issue