summaryrefslogtreecommitdiffstats
path: root/doc/bin
diff options
context:
space:
mode:
Diffstat (limited to 'doc/bin')
-rw-r--r--doc/bin/powertool.html61
-rw-r--r--doc/bin/set-ctrlaltdel.html51
2 files changed, 112 insertions, 0 deletions
diff --git a/doc/bin/powertool.html b/doc/bin/powertool.html
new file mode 100644
index 0000000..f4eb785
--- /dev/null
+++ b/doc/bin/powertool.html
@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>powertool</title>
+ <meta name="Description" content="Reference of the powertool program." />
+ <meta name="Keywords" content="linux linux-supplements shutdown halt reboot poweroff" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/linux-supplements">linux-supplements</a>
+ <br />
+ <a href="//0x53.net/software">Software</a>
+ <br />
+ <a href="//0x53.net">0x53.net</a>
+ </p>
+ </header>
+ <body>
+ <h1>The powertool program</h1>
+ <p>
+ powertool instructs the Linux Kernel to either
+ halt, poweroff or reboot.
+ This initiates hardware shutdown, not an orderly
+ shutdown of the system. It should be the last
+ program called during an orderly shutdown sequence.
+ </p>
+ <h2>Interface</h2>
+ <pre> powertool -h | -p | -r</pre>
+ <p>
+ powertool instructs the Linux Kernel according to the options given.
+ The op's listed below are documented
+ <a href="https://www.man7.org/linux/man-pages/man2/reboot.2.html">here</a>.
+ </p>
+ <h2>Options</h2>
+ <ul>
+ <li>
+ <code>-h</code>: Instruct the Linux Kernel to halt,
+ corresponding to the op <code>RB_HALT_SYSTEM</code>.
+ </li>
+ <li>
+ <code>-p</code>: Instruct the Linux Kernel to poweroff,
+ corresponding to the op <code>RB_POWER_OFF</code>.
+ </li>
+ <li>
+ <code>-r</code>: Instruct the Linux Kernel to reboot,
+ corresponding to the op <code>RB_AUTOBOOT</code>.
+ </li>
+ </ul>
+ <h2>Exit codes</h2>
+ <ul>
+ <li>
+ 100: wrong usage.
+ </li>
+ <li>
+ 111: system call failed.
+ </li>
+ </ul>
+ </body>
+</html>
diff --git a/doc/bin/set-ctrlaltdel.html b/doc/bin/set-ctrlaltdel.html
new file mode 100644
index 0000000..ef8c014
--- /dev/null
+++ b/doc/bin/set-ctrlaltdel.html
@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <title>set-ctrlaltdel</title>
+ <meta name="Description" content="Reference of the set-ctrlaltdel program." />
+ <meta name="Keywords" content="linux linux-supplements shutdown init" />
+ </head>
+ <header>
+ <p>
+ <a href="//0x53.net/software/linux-supplements">linux-supplements</a>
+ <br />
+ <a href="//0x53.net/software">Software</a>
+ <br />
+ <a href="//0x53.net">0x53.net</a>
+ </p>
+ </header>
+ <body>
+ <h1>The set-ctrlaltdel program</h1>
+ <p>
+ set-ctrlaltdel sets the action done upon pressing the
+ <code>CTRL + ALT + DEL</code> key combination.
+ </p>
+ <h2>Interface</h2>
+ <pre> set-ctrlaltdel -h | -s</pre>
+ <h2>Options</h2>
+ <ul>
+ <li>
+ <code>-h</code>: Instruct the Linux Kernel to instantly reboot
+ without a proper shutdown sequence upon pressing the key combination.
+ </li>
+ <li>
+ <code>-s</code>: Instruct the Linux Kernel to send SIGINT
+ to init (PID 1), which, in the case of
+ <a href="//0x53.net/software/goetia">goetia</a>,
+ initiates an orderly shutdown sequence.
+ </li>
+ </ul>
+ <h2>Exit codes</h2>
+ <ul>
+ <li>
+ 100: wrong usage.
+ </li>
+ <li>
+ 111: system call failed.
+ </li>
+ </ul>
+ </body>
+</html>