From a674b0b98cea6d578bcf922386fcccc4f430bf94 Mon Sep 17 00:00:00 2001 From: Aaron Bieber Date: Sun, 19 Jul 2020 08:07:12 -0600 Subject: [PATCH] add readme files for everything --- README.org | 36 ++++++++++++++++++------------------ completions/git.org | 22 ++++++++++++++++++++++ completions/gopass.org | 0 completions/man.org | 0 completions/rc.org | 0 completions/ssh.org | 0 completions/vmd.org | 0 extensions/fonts.org | 0 extensions/fzf.org | 0 extensions/git-prompt.org | 6 ++++++ extensions/k.org | 0 extensions/nocolor.org | 0 extensions/ohmy.org | 0 extensions/openbsd.org | 0 14 files changed, 46 insertions(+), 18 deletions(-) create mode 100644 completions/git.org create mode 100644 completions/gopass.org create mode 100644 completions/man.org create mode 100644 completions/rc.org create mode 100644 completions/ssh.org create mode 100644 completions/vmd.org create mode 100644 extensions/fonts.org create mode 100644 extensions/fzf.org create mode 100644 extensions/git-prompt.org create mode 100644 extensions/k.org create mode 100644 extensions/nocolor.org create mode 100644 extensions/ohmy.org create mode 100644 extensions/openbsd.org diff --git a/README.org b/README.org index 74cd816..f896f18 100644 --- a/README.org +++ b/README.org @@ -12,33 +12,33 @@ Have your cake and eat it too! ** Completions -| Name | Completes | -|------+------------------------| -| git | add, fetch... | -| gopass | audit, config... | -| man | man pages | -| rc | OpenBSD rc scripts and rc commands | -| ssh | ssh known hosts | -| vmd | vmctl commands and VM names | +| Name | Completes | +|--------+------------------------------------| +| [[completions/git.org][git]] | add, fetch... | +| [[completions/gopass.org][gopass]] | audit, config... | +| [[completions/man.org][man]] | man pages | +| [[completions/rc.org][rc]] | OpenBSD rc scripts and rc commands | +| [[completions/ssh.org][ssh]] | ssh known hosts | +| [[completions/vmd.org][vmd]] | vmctl commands and VM names | ** Extensions | Name | Description | |------------+-----------------------------------------------------------| -| fonts | Load fonts from common locations. | -| fzf | - | -| git-prompt | A port of git-prompt for KSH. | -| k | A tool to quickly change directories. | -| nocolor | Disable terminal color options for many tools. | -| openbsd | A set of tools for working with the OpenBSD source trees. | +| [[extensions/fonts.org][fonts]] | Load fonts from common locations. | +| [[extensions/fzf.org][fzf]] | - | +| [[extensions/git-prompt.org][git-prompt]] | A port of git-prompt for KSH. | +| [[extensions/k.org][k]] | A tool to quickly change directories. | +| [[extensions/nocolor.org][nocolor]] | Disable terminal color options for many tools. | +| [[extensions/openbsd.org][openbsd]] | A set of tools for working with the OpenBSD source trees. | ** Prompts -| Name | Example | -|------------+---------------------------| -| q | ~qbit@litr[0]:~$~ | -| og-openbsd | ~$~ | +| Name | Example | +|------------+-------------------| +| [[prompts/q.org][q]] | ~qbit@litr[0]:~$~ | +| [[prompts/og-openbsd.org][og-openbsd]] | ~$~ | ** Example usage diff --git a/completions/git.org b/completions/git.org new file mode 100644 index 0000000..2625b2f --- /dev/null +++ b/completions/git.org @@ -0,0 +1,22 @@ +* git completions + +The ~git~ completion currently supports the following arguments: + +** Level 1 +#+begin_src ksh + add am archive \ + bisect branch bundle \ + checkout cherry-pick citool clean clone commit config \ + describe diff \ + fetch format-patch \ + gc grep gui \ + init \ + log \ + merge mv \ + notes \ + pull push \ + range-diff rebase reset restore revert rm \ + shortlog show sparse-checkout stash status submodule switch \ + tag \ + worktree +#+end_src diff --git a/completions/gopass.org b/completions/gopass.org new file mode 100644 index 0000000..e69de29 diff --git a/completions/man.org b/completions/man.org new file mode 100644 index 0000000..e69de29 diff --git a/completions/rc.org b/completions/rc.org new file mode 100644 index 0000000..e69de29 diff --git a/completions/ssh.org b/completions/ssh.org new file mode 100644 index 0000000..e69de29 diff --git a/completions/vmd.org b/completions/vmd.org new file mode 100644 index 0000000..e69de29 diff --git a/extensions/fonts.org b/extensions/fonts.org new file mode 100644 index 0000000..e69de29 diff --git a/extensions/fzf.org b/extensions/fzf.org new file mode 100644 index 0000000..e69de29 diff --git a/extensions/git-prompt.org b/extensions/git-prompt.org new file mode 100644 index 0000000..7899beb --- /dev/null +++ b/extensions/git-prompt.org @@ -0,0 +1,6 @@ +* git-prompt extension + +This extension is a port of the [[https://github.com/git/git/blob/master/contrib/completion/git-prompt.sh][packaged git-prompt]] script to OpenBSD's ksh. + +It allows one to include git information in your PS1 or other scripts. + diff --git a/extensions/k.org b/extensions/k.org new file mode 100644 index 0000000..e69de29 diff --git a/extensions/nocolor.org b/extensions/nocolor.org new file mode 100644 index 0000000..e69de29 diff --git a/extensions/ohmy.org b/extensions/ohmy.org new file mode 100644 index 0000000..e69de29 diff --git a/extensions/openbsd.org b/extensions/openbsd.org new file mode 100644 index 0000000..e69de29