expand completion docs

This commit is contained in:
Aaron Bieber 2021-03-11 15:40:09 +00:00
parent 09db13f5d3
commit 05b501dbad
8 changed files with 170 additions and 24 deletions

View File

@ -1 +1,54 @@
#+TITLE: Completions: gopass
** Any level
#+begin_src shell
$PASS_LIST \
agent \
audit \
binary \
bin \
clone \
completion \
config \
copy \
cp \
create \
new \
delete \
remove \
rm \
edit \
set \
find \
search \
fsck \
generate \
git-credential \
jsonapi \
otp \
totp \
hotp \
git \
grep \
history \
hist \
init \
insert \
list \
ls \
move \
mv \
mounts \
recipients \
setup \
show \
sync \
templates \
unclip \
update \
version \
xc \
help \
h
#+end_src

View File

@ -4,30 +4,32 @@ The ~got~ completion currently supports the following arguments:
** Level 1
#+begin_src ksh
add \
bl blame \
bo backout \
br branch \
cat \
ci commit \
cl clone \
co checkout \
cy cherrypick \
di diff \
fe fetch \
he histedit \
ig integrate \
im import \
in init \
init \
import im \
clone cl \
fetch fe \
checkout co \
update up \
status st \
log \
rb rebase \
diff di \
blame bl \
tree tr \
ref \
rm remove \
rv revert \
sg stage \
st status \
branch br \
tag \
tr tree \
ug unstage \
up update
add \
remove rm \
revert rv \
commit ci \
cherrypick cy \
backout bo \
rebase rb \
histedit he \
integrate ig \
stage sg \
unstage ug \
cat \
info
#+end_src

View File

@ -1 +1,19 @@
#+TITLE: Completions: man
** Leven 1
Completions for man pages are found via:
#+begin_src shell
MANPATH=/usr/share/man man -k Nm~. | cut -d\( -f1 | tr -d , | \
sort | \
uniq > $MAN_CACH
#+end_src
Currently the cache is never re-created. Operating without a cache causes
significant load times. If one requires the cache to be refreshed they can run
the following in ~.xsession~ or similar:
#+begin_src shell
rm -f ${LOAD_PATH}/cache/man
#+end_src

View File

@ -18,7 +18,8 @@ set -A complete_mpc_1 -- \
toggle toggleoutput \
update \
version volume \
waitmessage \
waitmessage
pgrep -fq '/usr/local/sbin/mpd'
if [ $? = 0 ]; then
set -A complete_mpc_2 -- $(mpc lsplaylists | sort)

View File

@ -1 +1,36 @@
#+TITLE: Completions: mpc
** Level 1
The following completions are available for level one on MPC.
#+begin_src shell
add \
cdprev channels clear clearerror \
consume crop crossfade current \
del disable \
enable \
find findadd \
idle idleloop insert \
list listall load ls lsplaylists \
mixrampdb mixrampdelay move \
next \
outputs outputset \
pause pause-if-playing play playlist prev prio \
random repeat replaygain rescan rm \
save search searchadd searchplay seek \
sendmessage shuffle single stats \
sticker stop subscribe \
toggle toggleoutput \
update \
version volume \
waitmessage
#+end_src
** Level 2
#+begin_src shell
set -A complete_mpc_2 -- $(mpc lsplaylists | sort)
#+end_src
*Note:* Level 2 is only populated if ~mpd~ is running.

View File

@ -1 +1,13 @@
#+TITLE: Completions: rc
** Level 1
#+begin_src shell
disable enable get ls order set restart start stop
#+end_src
** Level 2
#+begin_src shell
$(rcctl ls all)
#+end_src

View File

@ -1 +1,10 @@
#+TITLE: Completions: ssh
** All Levels
#+begin_src shell
${HOST_LIST[*]}
#+end_src
~HOST_LIST~ is a combination of ~/etc/ssh/ssh_known_hosts~ and
~~/.ssh/known_hosts~.

View File

@ -1 +1,17 @@
#+TITLE: Completions: vmd
*Note:* Completions are only loaded if ~vmd~ is running.
** Level 1
#+begin_src shell
console load reload start stop reset status send receive
#+end_src
** All Levels
#+begin_src shell
$(vmctl status | awk '!/NAME/{print $NF}')
#+end_src