SOURCE/CORE/helpers.sh

   1 # check if input is a number, returns false or the number itself
   2 function check_noteID() {
   3         IN=$1
   4         case $IN in
   5                 ''|*[!0-9]*)
   6                         return 1
   7                         ;;
   8                 *)
   9                         echo "$IN"
  10                         ;;
  11         esac
  12 }
  13
  14 function helptext() {
  15     echo "Usage:"
  16     echo "  $0 [PARAMS] ..."
  17         echo ""
  18     echo "${BASENAME} parameters are:"
  19     echo -e "  -h | --help\t\t\t: This help text"
  20     echo -e "  -p | --plain\t\t\t: Output is in plain text"
  21     echo -e "\t\t\t\t  (without this option the output is formatted)"
  22     echo -e "\t\t\t\t  (this option must precede all others)"
  23     echo -e "  -l | --list\t\t\t: List existing notes"
  24     echo -e "  -a | --add=[\"<title>\"]\t: Add new note"
  25     echo -e "  -e | --edit=[<note>]\t\t: Edit note"
  26     echo -e "  -d | --delete=[<note> | all]     : Delete single note or all notes at once"
  27     echo -e "  -s | --show=[<note>]\t\t: Display note using your favourite PAGER"
  28     echo -e "  -r | --restore=[<dir>]\t: Restore a previous backup from dir"
  29     echo -e "  -v | --version\t\t: Print version"
  30     echo -e "  --userconf\t\t\t: Export User config file"
  31     echo -e "  --backup [<dest>]\t\t: Backup your data in your destination folder"
  32     echo ""
  33 }
  34
  35 function configtext() {
  36     cat << __NOWCONF__
  37 ${BASENAME} configuration is:
  38
  39 base directory:     ${BASEDIR}/
  40 notes archive:      ${NOTESDIR}/
  41 notes database:     ${DB}
  42 rc file:        $RCFILE
  43 debug file:     /tmp/debug_bash-note.log
  44
  45 text editor:        ${EDITOR}
  46 terminal:       ${TERMINAL}
  47 jq executable:      ${JQ}
  48 PAGER:                  ${PAGER}
  49 __NOWCONF__
  50
  51 }
  52