From 4de938d97af9561c7d89079e8f21c8fee97f17d4 Mon Sep 17 00:00:00 2001 From: Alexander Neumann Date: Tue, 26 Sep 2017 13:16:08 +0200 Subject: [PATCH] Update manpages and auto-completion --- doc/bash-completion.sh | 1121 +++++++++++++++++ doc/man/restic-autocomplete.1 | 78 -- doc/man/restic-backup.1 | 2 +- doc/man/restic-cat.1 | 2 +- doc/man/restic-check.1 | 2 +- doc/man/restic-dump.1 | 2 +- doc/man/restic-find.1 | 2 +- doc/man/restic-forget.1 | 2 +- .../{restic-manpage.1 => restic-generate.1} | 27 +- doc/man/restic-init.1 | 2 +- doc/man/restic-key.1 | 2 +- doc/man/restic-list.1 | 2 +- doc/man/restic-ls.1 | 2 +- doc/man/restic-migrate.1 | 2 +- doc/man/restic-mount.1 | 2 +- doc/man/restic-prune.1 | 2 +- doc/man/restic-rebuild-index.1 | 2 +- doc/man/restic-restore.1 | 2 +- doc/man/restic-snapshots.1 | 2 +- doc/man/restic-tag.1 | 2 +- doc/man/restic-unlock.1 | 2 +- doc/man/restic-version.1 | 2 +- doc/man/restic.1 | 4 +- doc/zsh-completion.zsh | 20 + 24 files changed, 1179 insertions(+), 109 deletions(-) create mode 100644 doc/bash-completion.sh delete mode 100644 doc/man/restic-autocomplete.1 rename doc/man/{restic-manpage.1 => restic-generate.1} (63%) create mode 100644 doc/zsh-completion.zsh diff --git a/doc/bash-completion.sh b/doc/bash-completion.sh new file mode 100644 index 000000000..5a2a1d6e3 --- /dev/null +++ b/doc/bash-completion.sh @@ -0,0 +1,1121 @@ +# bash completion for restic -*- shell-script -*- + +__debug() +{ + if [[ -n ${BASH_COMP_DEBUG_FILE} ]]; then + echo "$*" >> "${BASH_COMP_DEBUG_FILE}" + fi +} + +# Homebrew on Macs have version 1.3 of bash-completion which doesn't include +# _init_completion. This is a very minimal version of that function. +__my_init_completion() +{ + COMPREPLY=() + _get_comp_words_by_ref "$@" cur prev words cword +} + +__index_of_word() +{ + local w word=$1 + shift + index=0 + for w in "$@"; do + [[ $w = "$word" ]] && return + index=$((index+1)) + done + index=-1 +} + +__contains_word() +{ + local w word=$1; shift + for w in "$@"; do + [[ $w = "$word" ]] && return + done + return 1 +} + +__handle_reply() +{ + __debug "${FUNCNAME[0]}" + case $cur in + -*) + if [[ $(type -t compopt) = "builtin" ]]; then + compopt -o nospace + fi + local allflags + if [ ${#must_have_one_flag[@]} -ne 0 ]; then + allflags=("${must_have_one_flag[@]}") + else + allflags=("${flags[*]} ${two_word_flags[*]}") + fi + COMPREPLY=( $(compgen -W "${allflags[*]}" -- "$cur") ) + if [[ $(type -t compopt) = "builtin" ]]; then + [[ "${COMPREPLY[0]}" == *= ]] || compopt +o nospace + fi + + # complete after --flag=abc + if [[ $cur == *=* ]]; then + if [[ $(type -t compopt) = "builtin" ]]; then + compopt +o nospace + fi + + local index flag + flag="${cur%%=*}" + __index_of_word "${flag}" "${flags_with_completion[@]}" + COMPREPLY=() + if [[ ${index} -ge 0 ]]; then + PREFIX="" + cur="${cur#*=}" + ${flags_completion[${index}]} + if [ -n "${ZSH_VERSION}" ]; then + # zfs completion needs --flag= prefix + eval "COMPREPLY=( \"\${COMPREPLY[@]/#/${flag}=}\" )" + fi + fi + fi + return 0; + ;; + esac + + # check if we are handling a flag with special work handling + local index + __index_of_word "${prev}" "${flags_with_completion[@]}" + if [[ ${index} -ge 0 ]]; then + ${flags_completion[${index}]} + return + fi + + # we are parsing a flag and don't have a special handler, no completion + if [[ ${cur} != "${words[cword]}" ]]; then + return + fi + + local completions + completions=("${commands[@]}") + if [[ ${#must_have_one_noun[@]} -ne 0 ]]; then + completions=("${must_have_one_noun[@]}") + fi + if [[ ${#must_have_one_flag[@]} -ne 0 ]]; then + completions+=("${must_have_one_flag[@]}") + fi + COMPREPLY=( $(compgen -W "${completions[*]}" -- "$cur") ) + + if [[ ${#COMPREPLY[@]} -eq 0 && ${#noun_aliases[@]} -gt 0 && ${#must_have_one_noun[@]} -ne 0 ]]; then + COMPREPLY=( $(compgen -W "${noun_aliases[*]}" -- "$cur") ) + fi + + if [[ ${#COMPREPLY[@]} -eq 0 ]]; then + declare -F __custom_func >/dev/null && __custom_func + fi + + # available in bash-completion >= 2, not always present on macOS + if declare -F __ltrim_colon_completions >/dev/null; then + __ltrim_colon_completions "$cur" + fi +} + +# The arguments should be in the form "ext1|ext2|extn" +__handle_filename_extension_flag() +{ + local ext="$1" + _filedir "@(${ext})" +} + +__handle_subdirs_in_dir_flag() +{ + local dir="$1" + pushd "${dir}" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 +} + +__handle_flag() +{ + __debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}" + + # if a command required a flag, and we found it, unset must_have_one_flag() + local flagname=${words[c]} + local flagvalue + # if the word contained an = + if [[ ${words[c]} == *"="* ]]; then + flagvalue=${flagname#*=} # take in as flagvalue after the = + flagname=${flagname%%=*} # strip everything after the = + flagname="${flagname}=" # but put the = back + fi + __debug "${FUNCNAME[0]}: looking for ${flagname}" + if __contains_word "${flagname}" "${must_have_one_flag[@]}"; then + must_have_one_flag=() + fi + + # if you set a flag which only applies to this command, don't show subcommands + if __contains_word "${flagname}" "${local_nonpersistent_flags[@]}"; then + commands=() + fi + + # keep flag value with flagname as flaghash + if [ -n "${flagvalue}" ] ; then + flaghash[${flagname}]=${flagvalue} + elif [ -n "${words[ $((c+1)) ]}" ] ; then + flaghash[${flagname}]=${words[ $((c+1)) ]} + else + flaghash[${flagname}]="true" # pad "true" for bool flag + fi + + # skip the argument to a two word flag + if __contains_word "${words[c]}" "${two_word_flags[@]}"; then + c=$((c+1)) + # if we are looking for a flags value, don't show commands + if [[ $c -eq $cword ]]; then + commands=() + fi + fi + + c=$((c+1)) + +} + +__handle_noun() +{ + __debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}" + + if __contains_word "${words[c]}" "${must_have_one_noun[@]}"; then + must_have_one_noun=() + elif __contains_word "${words[c]}" "${noun_aliases[@]}"; then + must_have_one_noun=() + fi + + nouns+=("${words[c]}") + c=$((c+1)) +} + +__handle_command() +{ + __debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}" + + local next_command + if [[ -n ${last_command} ]]; then + next_command="_${last_command}_${words[c]//:/__}" + else + if [[ $c -eq 0 ]]; then + next_command="_$(basename "${words[c]//:/__}")" + else + next_command="_${words[c]//:/__}" + fi + fi + c=$((c+1)) + __debug "${FUNCNAME[0]}: looking for ${next_command}" + declare -F "$next_command" >/dev/null && $next_command +} + +__handle_word() +{ + if [[ $c -ge $cword ]]; then + __handle_reply + return + fi + __debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}" + if [[ "${words[c]}" == -* ]]; then + __handle_flag + elif __contains_word "${words[c]}" "${commands[@]}"; then + __handle_command + elif [[ $c -eq 0 ]] && __contains_word "$(basename "${words[c]}")" "${commands[@]}"; then + __handle_command + else + __handle_noun + fi + __handle_word +} + +_restic_backup() +{ + last_command="restic_backup" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--exclude=") + two_word_flags+=("-e") + local_nonpersistent_flags+=("--exclude=") + flags+=("--exclude-caches") + local_nonpersistent_flags+=("--exclude-caches") + flags+=("--exclude-file=") + local_nonpersistent_flags+=("--exclude-file=") + flags+=("--exclude-if-present=") + local_nonpersistent_flags+=("--exclude-if-present=") + flags+=("--files-from=") + local_nonpersistent_flags+=("--files-from=") + flags+=("--force") + flags+=("-f") + local_nonpersistent_flags+=("--force") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--hostname=") + local_nonpersistent_flags+=("--hostname=") + flags+=("--one-file-system") + flags+=("-x") + local_nonpersistent_flags+=("--one-file-system") + flags+=("--parent=") + local_nonpersistent_flags+=("--parent=") + flags+=("--stdin") + local_nonpersistent_flags+=("--stdin") + flags+=("--stdin-filename=") + local_nonpersistent_flags+=("--stdin-filename=") + flags+=("--tag=") + local_nonpersistent_flags+=("--tag=") + flags+=("--time=") + local_nonpersistent_flags+=("--time=") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_cat() +{ + last_command="restic_cat" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_check() +{ + last_command="restic_check" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--check-unused") + local_nonpersistent_flags+=("--check-unused") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--read-data") + local_nonpersistent_flags+=("--read-data") + flags+=("--with-cache") + local_nonpersistent_flags+=("--with-cache") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_dump() +{ + last_command="restic_dump" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_find() +{ + last_command="restic_find" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--host=") + two_word_flags+=("-H") + local_nonpersistent_flags+=("--host=") + flags+=("--ignore-case") + flags+=("-i") + local_nonpersistent_flags+=("--ignore-case") + flags+=("--long") + flags+=("-l") + local_nonpersistent_flags+=("--long") + flags+=("--newest=") + two_word_flags+=("-N") + local_nonpersistent_flags+=("--newest=") + flags+=("--oldest=") + two_word_flags+=("-O") + local_nonpersistent_flags+=("--oldest=") + flags+=("--path=") + local_nonpersistent_flags+=("--path=") + flags+=("--snapshot=") + two_word_flags+=("-s") + local_nonpersistent_flags+=("--snapshot=") + flags+=("--tag=") + local_nonpersistent_flags+=("--tag=") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_forget() +{ + last_command="restic_forget" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--keep-last=") + two_word_flags+=("-l") + local_nonpersistent_flags+=("--keep-last=") + flags+=("--keep-hourly=") + two_word_flags+=("-H") + local_nonpersistent_flags+=("--keep-hourly=") + flags+=("--keep-daily=") + two_word_flags+=("-d") + local_nonpersistent_flags+=("--keep-daily=") + flags+=("--keep-weekly=") + two_word_flags+=("-w") + local_nonpersistent_flags+=("--keep-weekly=") + flags+=("--keep-monthly=") + two_word_flags+=("-m") + local_nonpersistent_flags+=("--keep-monthly=") + flags+=("--keep-yearly=") + two_word_flags+=("-y") + local_nonpersistent_flags+=("--keep-yearly=") + flags+=("--keep-tag=") + local_nonpersistent_flags+=("--keep-tag=") + flags+=("--host=") + local_nonpersistent_flags+=("--host=") + flags+=("--hostname=") + local_nonpersistent_flags+=("--hostname=") + flags+=("--tag=") + local_nonpersistent_flags+=("--tag=") + flags+=("--path=") + local_nonpersistent_flags+=("--path=") + flags+=("--compact") + flags+=("-c") + local_nonpersistent_flags+=("--compact") + flags+=("--group-by=") + two_word_flags+=("-g") + local_nonpersistent_flags+=("--group-by=") + flags+=("--dry-run") + flags+=("-n") + local_nonpersistent_flags+=("--dry-run") + flags+=("--prune") + local_nonpersistent_flags+=("--prune") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_generate() +{ + last_command="restic_generate" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--bash-completion=") + local_nonpersistent_flags+=("--bash-completion=") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--man=") + local_nonpersistent_flags+=("--man=") + flags+=("--zsh-completion=") + local_nonpersistent_flags+=("--zsh-completion=") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_init() +{ + last_command="restic_init" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_key() +{ + last_command="restic_key" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_list() +{ + last_command="restic_list" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_ls() +{ + last_command="restic_ls" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--host=") + two_word_flags+=("-H") + local_nonpersistent_flags+=("--host=") + flags+=("--long") + flags+=("-l") + local_nonpersistent_flags+=("--long") + flags+=("--path=") + local_nonpersistent_flags+=("--path=") + flags+=("--tag=") + local_nonpersistent_flags+=("--tag=") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_migrate() +{ + last_command="restic_migrate" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--force") + flags+=("-f") + local_nonpersistent_flags+=("--force") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_mount() +{ + last_command="restic_mount" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--allow-other") + local_nonpersistent_flags+=("--allow-other") + flags+=("--allow-root") + local_nonpersistent_flags+=("--allow-root") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--host=") + two_word_flags+=("-H") + local_nonpersistent_flags+=("--host=") + flags+=("--owner-root") + local_nonpersistent_flags+=("--owner-root") + flags+=("--path=") + local_nonpersistent_flags+=("--path=") + flags+=("--tag=") + local_nonpersistent_flags+=("--tag=") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_prune() +{ + last_command="restic_prune" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_rebuild-index() +{ + last_command="restic_rebuild-index" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_restore() +{ + last_command="restic_restore" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--exclude=") + two_word_flags+=("-e") + local_nonpersistent_flags+=("--exclude=") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--host=") + two_word_flags+=("-H") + local_nonpersistent_flags+=("--host=") + flags+=("--include=") + two_word_flags+=("-i") + local_nonpersistent_flags+=("--include=") + flags+=("--path=") + local_nonpersistent_flags+=("--path=") + flags+=("--tag=") + local_nonpersistent_flags+=("--tag=") + flags+=("--target=") + two_word_flags+=("-t") + local_nonpersistent_flags+=("--target=") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_snapshots() +{ + last_command="restic_snapshots" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--compact") + flags+=("-c") + local_nonpersistent_flags+=("--compact") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--host=") + two_word_flags+=("-H") + local_nonpersistent_flags+=("--host=") + flags+=("--path=") + local_nonpersistent_flags+=("--path=") + flags+=("--tag=") + local_nonpersistent_flags+=("--tag=") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_tag() +{ + last_command="restic_tag" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--add=") + local_nonpersistent_flags+=("--add=") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--host=") + two_word_flags+=("-H") + local_nonpersistent_flags+=("--host=") + flags+=("--path=") + local_nonpersistent_flags+=("--path=") + flags+=("--remove=") + local_nonpersistent_flags+=("--remove=") + flags+=("--set=") + local_nonpersistent_flags+=("--set=") + flags+=("--tag=") + local_nonpersistent_flags+=("--tag=") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_unlock() +{ + last_command="restic_unlock" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--remove-all") + local_nonpersistent_flags+=("--remove-all") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic_version() +{ + last_command="restic_version" + commands=() + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--cache-dir=") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +_restic() +{ + last_command="restic" + commands=() + commands+=("backup") + commands+=("cat") + commands+=("check") + commands+=("dump") + commands+=("find") + commands+=("forget") + commands+=("generate") + commands+=("init") + commands+=("key") + commands+=("list") + commands+=("ls") + commands+=("migrate") + commands+=("mount") + commands+=("prune") + commands+=("rebuild-index") + commands+=("restore") + commands+=("snapshots") + commands+=("tag") + commands+=("unlock") + commands+=("version") + + flags=() + two_word_flags=() + local_nonpersistent_flags=() + flags_with_completion=() + flags_completion=() + + flags+=("--cache-dir=") + flags+=("--help") + flags+=("-h") + local_nonpersistent_flags+=("--help") + flags+=("--json") + flags+=("--no-cache") + flags+=("--no-lock") + flags+=("--option=") + two_word_flags+=("-o") + flags+=("--password-file=") + two_word_flags+=("-p") + flags+=("--quiet") + flags+=("-q") + flags+=("--repo=") + two_word_flags+=("-r") + + must_have_one_flag=() + must_have_one_noun=() + noun_aliases=() +} + +__start_restic() +{ + local cur prev words cword + declare -A flaghash 2>/dev/null || : + if declare -F _init_completion >/dev/null 2>&1; then + _init_completion -s || return + else + __my_init_completion -n "=" || return + fi + + local c=0 + local flags=() + local two_word_flags=() + local local_nonpersistent_flags=() + local flags_with_completion=() + local flags_completion=() + local commands=("restic") + local must_have_one_flag=() + local must_have_one_noun=() + local last_command + local nouns=() + + __handle_word +} + +if [[ $(type -t compopt) = "builtin" ]]; then + complete -o default -F __start_restic restic +else + complete -o default -o nospace -F __start_restic restic +fi + +# ex: ts=4 sw=4 et filetype=sh diff --git a/doc/man/restic-autocomplete.1 b/doc/man/restic-autocomplete.1 deleted file mode 100644 index f4450189e..000000000 --- a/doc/man/restic-autocomplete.1 +++ /dev/null @@ -1,78 +0,0 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" -.nh -.ad l - - -.SH NAME -.PP -restic\-autocomplete \- Generate shell autocompletion script - - -.SH SYNOPSIS -.PP -\fBrestic autocomplete [flags]\fP - - -.SH DESCRIPTION -.PP -The "autocomplete" command generates a shell autocompletion script. - -.PP -NOTE: The current version supports Bash only. - This should work for *nix systems with Bash installed. - -.PP -By default, the file is written directly to /etc/bash\_completion.d -for convenience, and the command may need superuser rights, e.g.: - -.PP -$ sudo restic autocomplete - - -.SH OPTIONS -.PP -\fB\-\-completionfile\fP="/usr/share/bash\-completion/completions/restic" - autocompletion file - -.PP -\fB\-h\fP, \fB\-\-help\fP[=false] - help for autocomplete - - -.SH OPTIONS INHERITED FROM PARENT COMMANDS -.PP -\fB\-\-cache\-dir\fP="" - set the cache directory - -.PP -\fB\-\-json\fP[=false] - set output mode to JSON for commands that support it - -.PP -\fB\-\-no\-cache\fP[=false] - do not use a local cache - -.PP -\fB\-\-no\-lock\fP[=false] - do not lock the repo, this allows some operations on read\-only repos - -.PP -\fB\-o\fP, \fB\-\-option\fP=[] - set extended option (\fB\fCkey=value\fR, can be specified multiple times) - -.PP -\fB\-p\fP, \fB\-\-password\-file\fP="" - read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE) - -.PP -\fB\-q\fP, \fB\-\-quiet\fP[=false] - do not output comprehensive progress report - -.PP -\fB\-r\fP, \fB\-\-repo\fP="" - repository to backup to or restore from (default: $RESTIC\_REPOSITORY) - - -.SH SEE ALSO -.PP -\fBrestic(1)\fP diff --git a/doc/man/restic-backup.1 b/doc/man/restic-backup.1 index fc3400645..22e9830a7 100644 --- a/doc/man/restic-backup.1 +++ b/doc/man/restic-backup.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-cat.1 b/doc/man/restic-cat.1 index 156cb8d32..279a3016c 100644 --- a/doc/man/restic-cat.1 +++ b/doc/man/restic-cat.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-check.1 b/doc/man/restic-check.1 index 2b6a3cb11..4bfc3a1b2 100644 --- a/doc/man/restic-check.1 +++ b/doc/man/restic-check.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-dump.1 b/doc/man/restic-dump.1 index afab6f159..8b1fb28e6 100644 --- a/doc/man/restic-dump.1 +++ b/doc/man/restic-dump.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-find.1 b/doc/man/restic-find.1 index 1c0ac962d..27007b053 100644 --- a/doc/man/restic-find.1 +++ b/doc/man/restic-find.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-forget.1 b/doc/man/restic-forget.1 index 06ac56dcb..62748f8cd 100644 --- a/doc/man/restic-forget.1 +++ b/doc/man/restic-forget.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-manpage.1 b/doc/man/restic-generate.1 similarity index 63% rename from doc/man/restic-manpage.1 rename to doc/man/restic-generate.1 index 6f9d5f898..591d6ad65 100644 --- a/doc/man/restic-manpage.1 +++ b/doc/man/restic-generate.1 @@ -1,33 +1,40 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l .SH NAME .PP -restic\-manpage \- Generate manual pages +restic\-generate \- Generate manual pages and auto\-completion files (bash, zsh) .SH SYNOPSIS .PP -\fBrestic manpage [command] [flags]\fP +\fBrestic generate [command] [flags]\fP .SH DESCRIPTION .PP -The "manpage" command generates a manual page for a single command. It can also -be used to write all manual pages to a directory. If the output directory is -set and no command is specified, all manpages are written to the directory. +The "generate" command writes automatically generated files like the man pages +and the auto\-completion files for bash and zsh). .SH OPTIONS .PP -\fB\-h\fP, \fB\-\-help\fP[=false] - help for manpage +\fB\-\-bash\-completion\fP="" + write bash completion \fB\fCfile\fR .PP -\fB\-\-output\-dir\fP="" - write man pages to this \fB\fCdirectory\fR +\fB\-h\fP, \fB\-\-help\fP[=false] + help for generate + +.PP +\fB\-\-man\fP="" + write man pages to \fB\fCdirectory\fR + +.PP +\fB\-\-zsh\-completion\fP="" + write zsh completion \fB\fCfile\fR .SH OPTIONS INHERITED FROM PARENT COMMANDS diff --git a/doc/man/restic-init.1 b/doc/man/restic-init.1 index ece3db2bc..2ddcdb3d6 100644 --- a/doc/man/restic-init.1 +++ b/doc/man/restic-init.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-key.1 b/doc/man/restic-key.1 index 81f4abf04..0f5a6d629 100644 --- a/doc/man/restic-key.1 +++ b/doc/man/restic-key.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-list.1 b/doc/man/restic-list.1 index 92793f6c7..13f568784 100644 --- a/doc/man/restic-list.1 +++ b/doc/man/restic-list.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-ls.1 b/doc/man/restic-ls.1 index e0dae4e21..351e7a47b 100644 --- a/doc/man/restic-ls.1 +++ b/doc/man/restic-ls.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-migrate.1 b/doc/man/restic-migrate.1 index b8a90a854..672b085c5 100644 --- a/doc/man/restic-migrate.1 +++ b/doc/man/restic-migrate.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-mount.1 b/doc/man/restic-mount.1 index 324208067..36e1cb2ea 100644 --- a/doc/man/restic-mount.1 +++ b/doc/man/restic-mount.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-prune.1 b/doc/man/restic-prune.1 index fde9a69d8..d1ec831eb 100644 --- a/doc/man/restic-prune.1 +++ b/doc/man/restic-prune.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-rebuild-index.1 b/doc/man/restic-rebuild-index.1 index 83baa4509..3c0f75d47 100644 --- a/doc/man/restic-rebuild-index.1 +++ b/doc/man/restic-rebuild-index.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-restore.1 b/doc/man/restic-restore.1 index bef55324b..f0d93782e 100644 --- a/doc/man/restic-restore.1 +++ b/doc/man/restic-restore.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-snapshots.1 b/doc/man/restic-snapshots.1 index c71f16b3a..f560bf396 100644 --- a/doc/man/restic-snapshots.1 +++ b/doc/man/restic-snapshots.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-tag.1 b/doc/man/restic-tag.1 index 031922ea8..7f774cdab 100644 --- a/doc/man/restic-tag.1 +++ b/doc/man/restic-tag.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-unlock.1 b/doc/man/restic-unlock.1 index 19430880c..ad4e27f3f 100644 --- a/doc/man/restic-unlock.1 +++ b/doc/man/restic-unlock.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic-version.1 b/doc/man/restic-version.1 index e1a8c2782..70c5d5ccc 100644 --- a/doc/man/restic-version.1 +++ b/doc/man/restic-version.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l diff --git a/doc/man/restic.1 b/doc/man/restic.1 index a07af6bd5..077dcf2c3 100644 --- a/doc/man/restic.1 +++ b/doc/man/restic.1 @@ -1,4 +1,4 @@ -.TH "restic backup" "1" "Jan 2017" "generated by `restic manpage`" "" +.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" .nh .ad l @@ -59,4 +59,4 @@ directories in an encrypted repository stored on different backends. .SH SEE ALSO .PP -\fBrestic\-autocomplete(1)\fP, \fBrestic\-backup(1)\fP, \fBrestic\-cat(1)\fP, \fBrestic\-check(1)\fP, \fBrestic\-dump(1)\fP, \fBrestic\-find(1)\fP, \fBrestic\-forget(1)\fP, \fBrestic\-init(1)\fP, \fBrestic\-key(1)\fP, \fBrestic\-list(1)\fP, \fBrestic\-ls(1)\fP, \fBrestic\-manpage(1)\fP, \fBrestic\-migrate(1)\fP, \fBrestic\-mount(1)\fP, \fBrestic\-prune(1)\fP, \fBrestic\-rebuild\-index(1)\fP, \fBrestic\-restore(1)\fP, \fBrestic\-snapshots(1)\fP, \fBrestic\-tag(1)\fP, \fBrestic\-unlock(1)\fP, \fBrestic\-version(1)\fP +\fBrestic\-backup(1)\fP, \fBrestic\-cat(1)\fP, \fBrestic\-check(1)\fP, \fBrestic\-dump(1)\fP, \fBrestic\-find(1)\fP, \fBrestic\-forget(1)\fP, \fBrestic\-generate(1)\fP, \fBrestic\-init(1)\fP, \fBrestic\-key(1)\fP, \fBrestic\-list(1)\fP, \fBrestic\-ls(1)\fP, \fBrestic\-migrate(1)\fP, \fBrestic\-mount(1)\fP, \fBrestic\-prune(1)\fP, \fBrestic\-rebuild\-index(1)\fP, \fBrestic\-restore(1)\fP, \fBrestic\-snapshots(1)\fP, \fBrestic\-tag(1)\fP, \fBrestic\-unlock(1)\fP, \fBrestic\-version(1)\fP diff --git a/doc/zsh-completion.zsh b/doc/zsh-completion.zsh new file mode 100644 index 000000000..a21f28ccf --- /dev/null +++ b/doc/zsh-completion.zsh @@ -0,0 +1,20 @@ +#compdef restic + +_arguments \ + '1: :->level1' \ + '2: :_files' +case $state in + level1) + case $words[1] in + restic) + _arguments '1: :(backup cat check dump find forget generate help init key list ls migrate mount options prune rebuild-index restore snapshots tag unlock version)' + ;; + *) + _arguments '*: :_files' + ;; + esac + ;; + *) + _arguments '*: :_files' + ;; +esac