From ca9bf74d0406d171b96a7708f4ce7061ed54922f Mon Sep 17 00:00:00 2001 From: kevin zhuang Date: Wed, 1 Jul 2020 17:49:38 +1000 Subject: [PATCH] docs(main): update help message --- dotbare | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/dotbare b/dotbare index 6944259..e7dc4db 100755 --- a/dotbare +++ b/dotbare @@ -17,28 +17,24 @@ source "${mydir}"/helper/set_variable.sh function usage() { echo -e "Usage: dotbare [-h] [-v] [COMMANDS] [OPTIONS] ...\n" - echo -e "Interactively manage dotfiles with the help of fzf and git bare repo" - echo -e "To see all dotbare specific COMMANDS, run dotbare without any arguments\n" - echo -e "dotbare is just a wrapper around git hence all git commands will function" - echo -e "normally, just replace git with dotbare (e.g. dotbare commit -m 'message')." - echo -e "dotbare added couple useful scripts starting with 'f' prefix to help you" - echo -e "manage your interact with your git bare repo a little easier with the help of fzf\n" + echo -e "Interactively manage dotfiles with the help of fzf and git bare repository." + echo -e "To see all dotbare specific COMMANDS, run dotbare without any arguments.\n" echo -e "optional arguments:" - echo -e " -h, --help\t\tshow this help message and exit" - echo -e " -v, --version\t\tshow dotbare current version" + echo -e " -h, --help\t\tshow this help message and exit." + echo -e " -v, --version\t\tshow dotbare current version.\n" echo -e "Available commands:" - echo -e " Any git commands, treat dotbare as git" - echo -e " fadd \t\tstage modified file interactively" - echo -e " freset \t\tunstage file or reset commit interactively" - echo -e " funtrack \t\tuntrack file interactively" - echo -e " fstash \t\tmanage stash interactively" - echo -e " fcheckout \t\tcheckout branch/files/commits interactively" - echo -e " fstat \t\tstage/unstage interactively" - echo -e " fedit \t\tselect files/commits and edit interactively" - echo -e " flog \t\tmanage commits interactively" - echo -e " fbackup \t\tperform backup for tracked dotfiles" - echo -e " fupgrade \t\tupdate dotbare to the latest version" - echo -e " finit \t\tinitialise/migrate dotbare" + echo -e " All git commands are available, treat dotbare as git." + echo -e " fadd \t\tstage files/directories interactively." + echo -e " freset \t\treset(unstage) files or commit interactively." + echo -e " funtrack \t\tuntrack files interactively." + echo -e " fstash \t\tmanage stash interactively." + echo -e " fcheckout \t\tcheckout branch/files/commit interactively." + echo -e " fstat \t\tinteractive menu to toggle stage/unstage." + echo -e " fedit \t\tinteractively select files/commit and edit." + echo -e " flog \t\tmanage commits interactively." + echo -e " fbackup \t\tperform backup for tracked files." + echo -e " fupgrade \t\tupdate dotbare to the latest master." + echo -e " finit \t\tinitialise dotbare or migrate dotfiles to a new machine." } # if no argument, display all possible actions