summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBernhard Voelker <mail@bernhard-voelker.de>2021-09-17 21:50:57 +0200
committerBernhard Voelker <mail@bernhard-voelker.de>2021-09-19 23:18:15 +0200
commit2c56e00ec9d6a735b9054513a3842dad0ef73394 (patch)
tree6fa24ecece91f54c72eefd032cbb4056bb45458a
parent45d8dd64d528e309d17c1cedefc4d4a33e593183 (diff)
downloadfindutils-2c56e00ec9d6a735b9054513a3842dad0ef73394.tar.gz
find: improve readability of --help output
* find/util.c (usage): Start sentences with upper case. Add extra newlines to put each section (operators, options, tests, and actions) on its own line. Move the typical generic options --help and --version to the end. * NEWS (Documentation Changes): Mention the change.
-rw-r--r--NEWS3
-rw-r--r--find/util.c46
2 files changed, 28 insertions, 21 deletions
diff --git a/NEWS b/NEWS
index 98d36323..17b08d4a 100644
--- a/NEWS
+++ b/NEWS
@@ -19,6 +19,9 @@ GNU findutils NEWS - User visible changes. -*- outline -*- (allout)
The find.1 man page and the Texinfo manual now show environment variables
in a consistent style. [#59963]
+ The output of 'find --help' now reads better.
+
+
* Noteworthy changes in release 4.8.0 (2020-01-09) [stable]
** Changes in xargs
diff --git a/find/util.c b/find/util.c
index 4446f89b..afd9880e 100644
--- a/find/util.c
+++ b/find/util.c
@@ -171,36 +171,40 @@ Usage: %s [-H] [-L] [-P] [-Olevel] [-D debugopts] [path...] [expression]\n"),
program_name);
HTL (_("\n\
-default path is the current directory; default expression is -print\n\
-expression may consist of: operators, options, tests, and actions:\n"));
- HTL (_("\
-operators (decreasing precedence; -and is implicit where no others are given):\n\
+Default path is the current directory; default expression is -print.\n\
+Expression may consist of: operators, options, tests, and actions.\n"));
+ HTL (_("\n\
+Operators (decreasing precedence; -and is implicit where no others are given):\n\
( EXPR ) ! EXPR -not EXPR EXPR1 -a EXPR2 EXPR1 -and EXPR2\n\
EXPR1 -o EXPR2 EXPR1 -or EXPR2 EXPR1 , EXPR2\n"));
- HTL (_("\
-positional options (always true): -daystart -follow -regextype\n\n\
-normal options (always true, specified before other expressions):\n\
- -depth --help -files0-from FILE -maxdepth LEVELS -mindepth LEVELS\n\
- -mount -noleaf --version -xdev -ignore_readdir_race\n\
- -noignore_readdir_race\n"));
- HTL (_("\
-tests (N can be +N or -N or N): -amin N -anewer FILE -atime N -cmin N\n\
- -cnewer FILE -ctime N -empty -false -fstype TYPE -gid N -group NAME\n\
- -ilname PATTERN -iname PATTERN -inum N -iwholename PATTERN -iregex PATTERN\n\
- -links N -lname PATTERN -mmin N -mtime N -name PATTERN -newer FILE"));
HTL (_("\n\
+Positional options (always true):\n\
+ -daystart -follow -nowarn -regextype -warn\n"));
+ HTL (_("\n\
+Normal options (always true, specified before other expressions):\n\
+ -depth -files0-from FILE -maxdepth LEVELS -mindepth LEVELS\n\
+ -mount -noleaf -xdev -ignore_readdir_race -noignore_readdir_race\n"));
+ HTL (_("\n\
+Tests (N can be +N or -N or N):\n\
+ -amin N -anewer FILE -atime N -cmin N -cnewer FILE -context CONTEXT\n\
+ -ctime N -empty -false -fstype TYPE -gid N -group NAME -ilname PATTERN\n\
+ -iname PATTERN -inum N -iwholename PATTERN -iregex PATTERN\n\
+ -links N -lname PATTERN -mmin N -mtime N -name PATTERN -newer FILE\n\
-nouser -nogroup -path PATTERN -perm [-/]MODE -regex PATTERN\n\
-readable -writable -executable\n\
-wholename PATTERN -size N[bcwkMG] -true -type [bcdpflsD] -uid N\n\
- -used N -user NAME -xtype [bcdpfls]"));
- HTL (_("\
- -context CONTEXT\n"));
+ -used N -user NAME -xtype [bcdpfls]\n"));
HTL (_("\n\
-actions: -delete -print0 -printf FORMAT -fprintf FILE FORMAT -print \n\
+Actions:\n\
+ -delete -print0 -printf FORMAT -fprintf FILE FORMAT -print \n\
-fprint0 FILE -fprint FILE -ls -fls FILE -prune -quit\n\
-exec COMMAND ; -exec COMMAND {} + -ok COMMAND ;\n\
- -execdir COMMAND ; -execdir COMMAND {} + -okdir COMMAND ;\n\
-\n"));
+ -execdir COMMAND ; -execdir COMMAND {} + -okdir COMMAND ;\n"));
+
+ HTL (_("\n\
+Other common options:\n"));
+ HTL (_(" --help display this help and exit\n"));
+ HTL (_(" --version output version information and exit\n\n"));
show_valid_debug_options (0);
HTL (_("\n\