From 9787b6b78eebe10ce4bb88c47b048b3b5ec4f259 Mon Sep 17 00:00:00 2001 From: Anton Novojilov Date: Fri, 8 Nov 2024 12:05:21 +0300 Subject: [PATCH] Improve help content --- .github/images/usage.svg | 42 +++++++++++++++++++------------------- cli/cli.go | 44 ++++++++++++++++++++-------------------- 2 files changed, 43 insertions(+), 43 deletions(-) diff --git a/.github/images/usage.svg b/.github/images/usage.svg index fffd44e..1b63ca7 100644 --- a/.github/images/usage.svg +++ b/.github/images/usage.svg @@ -57,27 +57,27 @@ Usage: path {options} {command} Commands - base path ............... Strip directory and suffix from filenames - dir path ................ Strip last component from file name - dirn num path ........... Return N elements from path - link path ............... Print resolved symbolic links or canonical file names - clean path .............. Print shortest path name equivalent to path by purely - lexical processing - compact path ............ Converts path to compact representation - abs path ................ Print absolute representation of path - ext path ................ Print file extension - match pattern path ...... Filter given path using pattern - join root path .......... Join path elements - add-prefix prefix path .. Add the substring at the beginning - del-prefix prefix path .. Remove the substring at the beginning - add-suffix suffix path .. Add the substring at the end - del-suffix suffix path .. Remove the substring at the end - exclude substr path ..... Exclude part of the string - strip-ext path .......... Remove file extension - is-abs path ............. Check if given path is absolute - is-local path ........... Check if given path is local - is-safe path ............ Check if given path is safe - is-match pattern path ... Check if given path is match to pattern + base path… ............... Strip directory and suffix from filenames + dir path… ................ Strip last component from file name + dirn num path… ........... Return N elements from path + link path… ............... Print resolved symbolic links or canonical file names + clean path… .............. Print shortest path name equivalent to path by purely + lexical processing + compact path… ............ Converts path to compact representation + abs path… ................ Print absolute representation of path + ext path… ................ Print file extension + match pattern path… ...... Filter given path using pattern + join root path… .......... Join path elements + add-prefix prefix path… .. Add the substring at the beginning + del-prefix prefix path… .. Remove the substring at the beginning + add-suffix suffix path… .. Add the substring at the end + del-suffix suffix path… .. Remove the substring at the end + exclude substr path… ..... Exclude part of the string + strip-ext path… .......... Remove file extension + is-abs path… ............. Check if given path is absolute + is-local path… ........... Check if given path is local + is-safe path… ............ Check if given path is safe + is-match pattern path… ... Check if given path is match to pattern Options --zero, -z ....... End each output line with NUL, not newline --space, -s ...... End each output line with space, not newline diff --git a/cli/cli.go b/cli/cli.go index f58f3c5..fa4bf46 100644 --- a/cli/cli.go +++ b/cli/cli.go @@ -255,28 +255,28 @@ func printMan() { func genUsage() *usage.Info { info := usage.NewInfo() - info.AddCommand(CMD_BASENAME, "Strip directory and suffix from filenames", "?path") - info.AddCommand(CMD_DIRNAME, "Strip last component from file name", "?path") - info.AddCommand(CMD_DIRNAME_NUM, "Return N elements from path", "num", "?path") - info.AddCommand(CMD_READLINK, "Print resolved symbolic links or canonical file names", "?path") - info.AddCommand(CMD_CLEAN, "Print shortest path name equivalent to path by purely lexical processing", "?path") - info.AddCommand(CMD_COMPACT, "Converts path to compact representation", "?path") - info.AddCommand(CMD_ABS, "Print absolute representation of path", "?path") - info.AddCommand(CMD_EXT, "Print file extension", "?path") - info.AddCommand(CMD_MATCH, "Filter given path using pattern", "pattern", "?path") - info.AddCommand(CMD_JOIN, "Join path elements", "root", "?path") - - info.AddCommand(CMD_ADD_PREFIX, "Add the substring at the beginning", "prefix", "?path") - info.AddCommand(CMD_DEL_PREFIX, "Remove the substring at the beginning", "prefix", "?path") - info.AddCommand(CMD_ADD_SUFFIX, "Add the substring at the end", "suffix", "?path") - info.AddCommand(CMD_DEL_SUFFIX, "Remove the substring at the end", "suffix", "?path") - info.AddCommand(CMD_EXCLUDE, "Exclude part of the string", "substr", "?path") - info.AddCommand(CMD_STRIP_EXT, "Remove file extension", "?path") - - info.AddCommand(CMD_IS_ABS, "Check if given path is absolute", "?path") - info.AddCommand(CMD_IS_LOCAL, "Check if given path is local", "?path") - info.AddCommand(CMD_IS_SAFE, "Check if given path is safe", "?path") - info.AddCommand(CMD_IS_MATCH, "Check if given path is match to pattern", "pattern", "?path") + info.AddCommand(CMD_BASENAME, "Strip directory and suffix from filenames", "?path…") + info.AddCommand(CMD_DIRNAME, "Strip last component from file name", "?path…") + info.AddCommand(CMD_DIRNAME_NUM, "Return N elements from path", "num", "?path…") + info.AddCommand(CMD_READLINK, "Print resolved symbolic links or canonical file names", "?path…") + info.AddCommand(CMD_CLEAN, "Print shortest path name equivalent to path by purely lexical processing", "?path…") + info.AddCommand(CMD_COMPACT, "Converts path to compact representation", "?path…") + info.AddCommand(CMD_ABS, "Print absolute representation of path", "?path…") + info.AddCommand(CMD_EXT, "Print file extension", "?path…") + info.AddCommand(CMD_MATCH, "Filter given path using pattern", "pattern", "?path…") + info.AddCommand(CMD_JOIN, "Join path elements", "root", "?path…") + + info.AddCommand(CMD_ADD_PREFIX, "Add the substring at the beginning", "prefix", "?path…") + info.AddCommand(CMD_DEL_PREFIX, "Remove the substring at the beginning", "prefix", "?path…") + info.AddCommand(CMD_ADD_SUFFIX, "Add the substring at the end", "suffix", "?path…") + info.AddCommand(CMD_DEL_SUFFIX, "Remove the substring at the end", "suffix", "?path…") + info.AddCommand(CMD_EXCLUDE, "Exclude part of the string", "substr", "?path…") + info.AddCommand(CMD_STRIP_EXT, "Remove file extension", "?path…") + + info.AddCommand(CMD_IS_ABS, "Check if given path is absolute", "?path…") + info.AddCommand(CMD_IS_LOCAL, "Check if given path is local", "?path…") + info.AddCommand(CMD_IS_SAFE, "Check if given path is safe", "?path…") + info.AddCommand(CMD_IS_MATCH, "Check if given path is match to pattern", "pattern", "?path…") info.AddOption(OPT_ZERO, "End each output line with NUL, not newline") info.AddOption(OPT_SPACE, "End each output line with space, not newline")