update usage output

This commit is contained in:
Denis Lehmann 2021-09-12 14:53:00 +02:00
parent 824ec45c22
commit fa08f80c28

46
strm
View file

@ -5,28 +5,30 @@ text_bold="\e[1m"
text_reset="\e[0m"
function print_usage {
echo "Usage: strm [OPTIONS] QUERIES ... [OPTIONS]"
echo
echo "Stream media files over SSH in a convenient way."
echo
echo "OPTIONS"
echo " -h, --help Show this help message"
echo " -c, --config CONFIG_FILE Path to config file (default: ~/.config/strm/strm.config)"
echo " -f, --fullscreen Play video files in fullscreen"
echo " -i, --ignore-files IGNORE_FILES Ignore given filenames"
echo " -l, --list List files instead of playing"
echo " -m, --media-directories MEDIA_DIRECTORIES Use given media directories, config is ignored"
echo " -o, --or Combine queries with a logical OR (default: AND)"
echo " -p, --playback-directory DIRECTORY Use given playback directory"
echo " -q, --quit TIME_IN_MINUTES Quit after a given time"
echo " -r, --remote SSH_CONNECTION_STRING Execute strm with other given arguments on remote machine (-f is set by default)"
echo " -s, --shuffle Play files in random order"
echo " -t, --tidy Don't resume playback"
echo
echo "EXAMPLES"
echo " strm -l . # List all available files"
echo " strm Elephants Dream # Play files whose path contain 'elephants' and 'dream'"
echo " strm e*phants # Play files whose path matches the glob pattern 'e*phants'"
cat <<EOF
Usage: strm [OPTIONS] QUERIES ... [OPTIONS]
Stream media files over SSH in a convenient way.
OPTIONS
-h, --help Show this help message
-c, --config CONFIG_FILE Path to config file (default: ~/.config/strm/strm.config)
-f, --fullscreen Play video files in fullscreen
-i, --ignore-files IGNORE_FILES Ignore given filenames
-l, --list List files instead of playing
-m, --media-directories MEDIA_DIRECTORIES Use given media directories, config is ignored
-o, --or Combine queries with a logical OR (default: AND)
-p, --playback-directory DIRECTORY Use given playback directory
-q, --quit TIME_IN_MINUTES Quit after a given time
-r, --remote SSH_CONNECTION_STRING Execute strm with other given arguments on remote machine (-f is set by default)
-s, --shuffle Play files in random order
-t, --tidy Don't resume playback
EXAMPLES
strm -l . # List all available files
strm Elephants Dream # Play files whose path contain 'elephants' and 'dream'
strm e*phants # Play files whose path matches the glob pattern 'e*phants'
EOF
exit
}