Correct a few missing words in help

[code/vcsh.git] / vcsh

diff --git a/vcsh b/vcsh
index 358135a48ed814b63218d0fef0b6a68023afae0e..496a43f2cb0dba9e9b121218da13a01bab5b59bd 100755 (executable)
--- a/vcsh
+++ b/vcsh
@@ -11,24 +11,74 @@
 # full compability with git. In case git ever changes its licensing terms,
 # this software will most likely follow suit.
 
 # full compability with git. In case git ever changes its licensing terms,
 # this software will most likely follow suit.
 

+SELF=$(basename $0)
+
+fatal() {
+       echo "$SELF: fatal: $1" >&2
+       exit $2
+}
+
+# We need to run getops as soon as possible so we catch -d and other
+# options that will modify our behaviour.
+# Commands are handled at the end of this script.
+while getopts  "c:dv" flag; do
+       if [ "$1" = '-d' ] || [ "$1" = '--debug' ]; then
+               set -vx
+               VCSH_DEBUG=1
+               shift 1
+       elif [ "$1" = '-v' ];then
+               VCSH_VERBOSE=1
+       elif [ "$1" = '-c' ];then
+               VCSH_OPTION_CONFIG=$OPTARG
+       fi
+done
+
+source_all() {
+       # Source file even if it's in $PWD and does not have any slashes in it
+       case "$1" in
+               */*) . "$1";;
+               *)   . "$PWD/$1";;
+       esac;
+}
+
+
+# Read configuration and set defaults if anything's not set

 [ -n "$VCSH_DEBUG" ]                  && set -vx
 [ -z "$XDG_CONFIG_HOME" ]             && XDG_CONFIG_HOME="$HOME/.config"
 [ -n "$VCSH_DEBUG" ]                  && set -vx
 [ -z "$XDG_CONFIG_HOME" ]             && XDG_CONFIG_HOME="$HOME/.config"

+
+# Read configuration files if there are any
+[ -r "/etc/vcsh/config" ]             && . "/etc/vcsh/config"

 [ -r "$XDG_CONFIG_HOME/vcsh/config" ] && . "$XDG_CONFIG_HOME/vcsh/config"
 [ -r "$XDG_CONFIG_HOME/vcsh/config" ] && . "$XDG_CONFIG_HOME/vcsh/config"

+if [ -n "$VCSH_OPTION_CONFIG" ]; then
+       # Source $VCSH_OPTION_CONFIG if it can be read and is in $PWD of $PATH
+       if [ -r "$VCSH_OPTION_CONFIG" ]; then
+               source_all "$VCSH_OPTION_CONFIG"
+       else
+               fatal "Can not read configuration file '$VCSH_OPTION_CONFIG'" 1
+       fi
+fi

 [ -n "$VCSH_DEBUG" ]                  && set -vx
 [ -n "$VCSH_DEBUG" ]                  && set -vx

+
+# Read defaults

 [ -z "$VCSH_REPO_D" ]                 && VCSH_REPO_D="$XDG_CONFIG_HOME/vcsh/repo.d"
 [ -z "$VCSH_HOOK_D" ]                 && VCSH_HOOK_D="$XDG_CONFIG_HOME/vcsh/hooks-enabled"
 [ -z "$VCSH_BASE" ]                   && VCSH_BASE="$HOME"
 [ -z "$VCSH_GITIGNORE" ]              && VCSH_GITIGNORE='exact'
 
 [ -z "$VCSH_REPO_D" ]                 && VCSH_REPO_D="$XDG_CONFIG_HOME/vcsh/repo.d"
 [ -z "$VCSH_HOOK_D" ]                 && VCSH_HOOK_D="$XDG_CONFIG_HOME/vcsh/hooks-enabled"
 [ -z "$VCSH_BASE" ]                   && VCSH_BASE="$HOME"
 [ -z "$VCSH_GITIGNORE" ]              && VCSH_GITIGNORE='exact'
 

-SELF=$(basename $0)

 
 help() {
 
 help() {

-       echo "usage: $SELF <args>
+       echo "usage: $SELF <options> <command>

 
 

+   options:
+   -c <file>            Source file
+   -d                   Enable debug mode
+   -v                   Enable verbose mode
+
+   commands:

    clone <remote> \\
          [<repo>]       Clone from an existing repository
    clone <remote> \\
          [<repo>]       Clone from an existing repository

-   delete               Delete an existing repository
-   enter                Enter repository; spawn new instance of \$SHELL
+   delete <repo>        Delete an existing repository
+   enter <repo>         Enter repository; spawn new instance of \$SHELL

    help                 Display this help text
    init <repo>          Initialize a new repository
    list                 List all repositories
    help                 Display this help text
    init <repo>          Initialize a new repository
    list                 List all repositories


@@ -39,7 +89,7 @@ help() {
           <newname>     Rename repository
    run <repo> \\
        <command>        Use this repository
           <newname>     Rename repository
    run <repo> \\
        <command>        Use this repository

-   setup                Set up repository with recommended settings
+   setup <repo>         Set up repository with recommended settings

    which <substring>    Find substring in name of any tracked file
    write-gitignore \\
    <repo>               Write .gitignore.d/<repo> via git ls-files
    which <substring>    Find substring in name of any tracked file
    write-gitignore \\
    <repo>               Write .gitignore.d/<repo> via git ls-files


@@ -56,11 +106,6 @@ verbose() {
        if [ -n "$VCSH_DEBUG" ] || [ -n "$VCSH_VERBOSE" ]; then echo "$SELF: verbose: $@"; fi
 }
 
        if [ -n "$VCSH_DEBUG" ] || [ -n "$VCSH_VERBOSE" ]; then echo "$SELF: verbose: $@"; fi
 }
 

-fatal() {
-       echo "$SELF: fatal: $1" >&2
-       exit $2
-}
-

 error() {
        echo "$SELF: error: $1" >&2
 }
 error() {
        echo "$SELF: error: $1" >&2
 }