From: Armaan Bhojwani Date: Sun, 30 May 2021 04:36:05 +0000 (-0400) Subject: Write manpages X-Git-Url: https://git.armaanb.net/?p=bin.git;a=commitdiff_plain;h=4ba91f5f510300595d42503fb18b3bc1ee4db23c Write manpages --- diff --git a/man/autostart.1.scd b/man/autostart.1.scd new file mode 100644 index 0000000..acc8b76 --- /dev/null +++ b/man/autostart.1.scd @@ -0,0 +1,15 @@ +autostart(1) + +# NAME +autostart - automatically start my programs + +# SYNOPSIS +*autostart* + +# DESCRIPTION +This script just runs the daemons and such that I use, killing any already +running instances before-hand. + +# COPYRIGHT +This is free and unencumbered software released into the public domain. For more +information, please refer to . \ No newline at end of file diff --git a/man/chrooter.1.scd b/man/chrooter.1.scd new file mode 100644 index 0000000..9370147 --- /dev/null +++ b/man/chrooter.1.scd @@ -0,0 +1,13 @@ +chrooter(1) + +# NAME +chrooter - chroot wrapper + +# SYNOPSIS +chrooter [mount point] + +# DESCRIPTION +Directly based on Dylan Arap's kiss-chroot script, this + +# COPYRIGHT +Copyright 2019-2020 Dylan Araps, 2021 Armaan Bhojwani, MIT License. \ No newline at end of file diff --git a/man/crontab-argh.1.scd b/man/crontab-argh.1.scd new file mode 100644 index 0000000..14c6db6 --- /dev/null +++ b/man/crontab-argh.1.scd @@ -0,0 +1,35 @@ +crontab-argh(1) + +# NAME +crontab-argh - crontab wrapper that safegaurds -r + +# SYNOPSIS +*crontab-argh* [normal cron usage] + +# DESCRIPTION +We've all done it, the perilous finger slip, what was intended to be an innocent +crontab -e turns into crontab -r. After you hit return, you are confused as to +why you weren't dropped into your editor, maybe your config file is bad? But no, +in horror you read the terminal and see that your user's crontab was +deleted. You swear to make better backups in the future, but you and I both know +that that will never happen. So in despair, you install crontab-argh, symlink it +to crontab, and the world is in harmony. You will never again accidentally run +crontab -r. + +Some cron implementations implement a -R flag which does the same thing as this, +however it still relies on remembering to use a more inconvenient flag, and is +nonstandard. + +It is recommended to symlink crontab-argh to crontab in a higher priority +directory in your $PATH, or to use a shell alias. Bear in mind that the reason +that -r still behaves in this obnoxious way is for compatibility. Using +crontab-argh may break some scripts. Only the -r flag will be intercepted, +however, and everything else gets passed on to crontab, so for the most part, it +should be fine. + +# SEE ALSO +crontab(1), cron(8) + +# COPYRIGHT +This is free and unencumbered software released into the public domain. For more +information, please refer to . \ No newline at end of file diff --git a/man/fortune.1.scd b/man/fortune.1.scd new file mode 100644 index 0000000..c9afad2 --- /dev/null +++ b/man/fortune.1.scd @@ -0,0 +1,47 @@ +fortune(1) + +# NAME +fortune - fortune implementation in POSIX awk/sh + +# SYNOPSIS +*fortune*++ +*fortune* [options] + +# DESCRIPTION +This is a reimplementation of the classic fortune program in POSIX compliant +awk/sh. Why is this needed? The classic fortune program included in the BSDs +isn't portable, and fortune-mod has the craziest build system ever dreamt +of. This script does a good enough job for most fortune seekers. + +The meat and potatoes of the script is some awk code, however it is wrapped in a +shell script to do argument parsing. + +fortune looks for cookie files in $FORTUNEDIR, which defaults to +/usr/share/fortune. Cookie files are simple text files with each fortune +seperated by a "%" on a newline. Examples can be found at +. + +# OPTIONS +*-h*, *--help* + Show a help message + +*-l*, *--list* + List installed cookie files + +*-c*, *--cookie* + Specify a cookie file + +*-n*, *--min* MINIMUM_LENGTH + Specify a minimum output length + +*-N*, *--max* MAXIMUM_LENGTH + Specify a maximum output length + +# EXIT CODES +*0* Success++ +*1* Generic error++ +*2* Argument parsing error + +# COPYRIGHT +This is free and unencumbered software released into the public domain. For more +information, please refer to . diff --git a/man/git-check.1.scd b/man/git-check.1.scd new file mode 100644 index 0000000..5d8517e --- /dev/null +++ b/man/git-check.1.scd @@ -0,0 +1,14 @@ +get-check(1) + +# NAME +git-check - print a summary of Git repos in a directory + +# SYNOPSIS +*git* check [directory] + +# DESCRIPTION +Prints a diffstat for each repo in $PWD or given directory. + +# COPYRIGHT +This is free and unencumbered software released into the public domain. For more +information, please refer to . \ No newline at end of file diff --git a/man/morse.1.scd b/man/morse.1.scd new file mode 100644 index 0000000..2177edf --- /dev/null +++ b/man/morse.1.scd @@ -0,0 +1,18 @@ +morse(1) + +# NAME +morse - translate morse code + +# SYNOPSIS +*morse* + +*morse* [ASCII text] + +# Description +Morse reads ASCII text from the STDIN or the command line arguments, and +code. Note that there no help command. A "?" will be printed when there is no +morse code translation for the input character. + +# COPYRIGHT +This is free and unencumbered software released into the public domain. For more +information, please refer to . \ No newline at end of file diff --git a/man/passmenu.1.scd b/man/passmenu.1.scd new file mode 100644 index 0000000..7018671 --- /dev/null +++ b/man/passmenu.1.scd @@ -0,0 +1,16 @@ +passmenu(1) + +# NAME +passmenu - get pash(1) passwords through dmenu(1). + +# SYNOPSIS +*passmenu* + +# DESCRIPTION +This script lets you copy passwords stored in pash(1) via dmenu. There are many +similar scripts to this, however this one is designed to work perfectly with +Dylan Arap's pash(1), and is POSIX compliant. + +# COPYRIGHT +This is free and unencumbered software released into the public domain. For more +information, please refer to . \ No newline at end of file diff --git a/man/scoop-cgi.1.scd b/man/scoop-cgi.1.scd new file mode 100644 index 0000000..0a12a7b --- /dev/null +++ b/man/scoop-cgi.1.scd @@ -0,0 +1,31 @@ +scoop-cgi(1) + +# NAME +scoop-cgi - run scoop as a cgi script + +# SYNOPSIS +Run with your favorite web server + +# DESCRIPTION +june's scooper is a great, full-featured web interface to litterbox, however it +is relatively complex. The plaintext output of scoop is good enough for me. This +script just makes it accesible via the web. Requires scoop and litterbox. + +# CONFIGURATION +There are two config files that go in /etc/scoop-cgi/channels, and +/etc/scoop-cgi/database. The channels file has a list of channels for which +public logging is enabled, and the database file has the path to the litterbox +database file. + +# DRAWBACKS +- No built-in search functionality. Combine with YaCy or scoot for a searching + solution. +- Only supports a single database at a time +- Homepage text is hard coded + +# SEE ALSO +scoop(1), litterbox(1) + +# COPYRIGHT +This is free and unencumbered software released into the public domain. For more +information, please refer to . \ No newline at end of file diff --git a/man/setter.1.scd b/man/setter.1.scd new file mode 100644 index 0000000..7272209 --- /dev/null +++ b/man/setter.1.scd @@ -0,0 +1,30 @@ +setter(1) + +# NAME +setter - media hotkey backend + +# SYNOPSIS +*setter*++ +*setter* status++ +*setter* audio++ +*setter* brightness + +# DESCRIPTION +The various subcommands of setter are designed to be bound to various media +keys. setter without a subcommand is an alias to "status". + +# SUBCOMMANDS +*status* + Show a notification with time/date, battery level, volume. + +*audio* + Without an argument: toggles mute. + + Without an argument: increments volume by the specified percent. + +*brightness* + Increments the backlight brightness by the specified percent. + +# COPYRIGHT +This is free and unencumbered software released into the public domain. For more +information, please refer to . \ No newline at end of file