diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/bin/powertool.html | 61 | ||||
| -rw-r--r-- | doc/bin/set-ctrlaltdel.html | 51 | ||||
| -rw-r--r-- | doc/index.html | 85 | ||||
| -rw-r--r-- | doc/linux-supplements-0.1.0.0.tar.gz | bin | 0 -> 19270 bytes | |||
| -rw-r--r-- | doc/linux-supplements-0.1.0.0.tar.gz.sha256 | 1 |
5 files changed, 198 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> diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..084a94f --- /dev/null +++ b/doc/index.html @@ -0,0 +1,85 @@ +<!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>linux-supplements</title> + <meta name="Description" content="Minimal utilities for Linux that, mainly for goetia." /> + <meta name="Keywords" content="linux goetia" /> + </head> + <header> + <p> + <a href="//0x53.net/software">Software</a> + <br /> + <a href="//0x53.net">0x53.net</a> + </p> + </header> + <body> + <h1>linux-supplements</h1> + <h2>What is it?</h2> + <p> + linux-supplements contains utilities that + <a href="./goetia">goetia</a> on Linux + requires, but are not consistently + part of software packages providing + Linux Kernel specific tools. + (see <a href="//0x53.net/software/requirements.html">here</a>). + </p> + <hr> + <h2>Installation</h2> + <h3>Requirements</h3> + <ul> + <li> + A POSIX-compliant system with a standard C development environment + </li> + <li> + GNU make, version 3.81 or later + </li> + <li> + <a href="https://skarnet.org/software/skalibs/">skalibs</a> version + 2.14.4.0 or later. It's a build-time requirement. It's also a run-time + requirement if you link against the shared version of the skalibs + library. + </li> + </ul> + <h3>Licensing</h3> + <p> + linux-supplements is free software. It is available under the + <a href="https://opensource.org/licenses/ISC">ISC license</a>. + </p> + <h3>Download</h3> + <ul> + <li> + The current released version of linux-supplements is + <a href="linux-supplements-0.1.0.0.tar.gz">0.1.0.0</a>. + You can access its checksum + <a href="linux-supplements-0.1.0.0.tar.gz.sha256">here</a>. + </li> + <li> + Alternatively, you can checkout a copy of the + <a href="https://git.0x53.net/linux-supplements">linux-supplements git repository</a>: + <pre>git clone git://git.0x53.net/linux-supplements</pre> + </li> + </ul> + <h3>Compilation</h3> + <ul> + <li> + See the enclosed INSTALL file for installation details. + </li> + </ul> + <hr> + <h2>Reference</h2> + <section id="bin"> + <h3>Commands</h3> + <ul> + <li> + <a href="./bin/powertool.html">powertool</a> + </li> + <li> + <a href="./bin/set-ctrlaltdel.html">set-ctrlaltdel</a> + </li> + </ul> + </section> + </body> +</html> diff --git a/doc/linux-supplements-0.1.0.0.tar.gz b/doc/linux-supplements-0.1.0.0.tar.gz Binary files differnew file mode 100644 index 0000000..7844609 --- /dev/null +++ b/doc/linux-supplements-0.1.0.0.tar.gz diff --git a/doc/linux-supplements-0.1.0.0.tar.gz.sha256 b/doc/linux-supplements-0.1.0.0.tar.gz.sha256 new file mode 100644 index 0000000..ad23d5d --- /dev/null +++ b/doc/linux-supplements-0.1.0.0.tar.gz.sha256 @@ -0,0 +1 @@ +37756de7ccba79772cad3c2fd649b3bee0efc360ea9b1b72782f002551409553 linux-supplements-0.1.0.0.tar.gz |