diff options
| author | Hank <hanketsu@egregore.fun> | 2025-04-06 12:49:19 +0200 |
|---|---|---|
| committer | Hank <hanketsu@egregore.fun> | 2025-04-06 12:49:29 +0200 |
| commit | 305c6536341ca2e9d93908a1a7b5929f2db17c42 (patch) | |
| tree | 915de785f6609449d1c48bbc4c4fb0668a6af726 | |
| parent | f74e3d8b644e967825c73aeebb141bab7b277b10 (diff) | |
docs: add man page
| -rw-r--r-- | pm-suspend.1 | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/pm-suspend.1 b/pm-suspend.1 new file mode 100644 index 0000000..878a1ec --- /dev/null +++ b/pm-suspend.1 @@ -0,0 +1,30 @@ +.TH pm-suspend 1 "06 April 25" +.SH NAME +pm-suspend - Suspend the system. +.SH SYNOPSIS +\fBpm-suspend\fP [ mem | standby | freeze | disk ] +.SH DESCRIPTION +\fBpm-suspend\fP suspends the system by writing to +the device located at \fB/sys/power/state\fP. +The required argument specifies the kind of +suspend used. +.SS Arguments +.TP +\fBmem\fP +Suspend the system according to the \fC/sys/power/mem_sleep\fR file. See below. +.TP +\fBstandby\fP +Suspend the system using power-on suspend, if supported. +.TP +\fBfreeze\fP +Suspend the system using suspend-to-idle. +.TP +\fBdisk\fP +Suspend the system via hibernation, also called suspend-to-disk. +.SH FILES +.TP +\fC/sys/power/state\fR +The special state file that will receive suspend commands. +.TP +\fC/sys/power/mem_sleep\fR +The control file that will determine what mode the \fBmem\fP command uses. See kernel documentation. |