Clarify that file filters are apply to the full path of the file.

acaudwell · Feb 13, 2018 · 4ea1e32 · 4ea1e32
1 parent 4114a9d
commit 4ea1e32
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/README b/README
@@ -188,13 +188,13 @@ options:
             Show filename extensions only.
 
     --file-filter REGEX
-            Filter out any files matching a specified regular expression.
+            Filter out file paths matching the specified regular expression.
 
     --file-show-filter REGEX
-            Show only files matching this regular expression.
+            Show only file paths matching the specified regular expression.
 
     --user-filter REGEX
-            Filter out any users matching a specified regular expression.
+            Filter usernames matching the specified regular expression.
 
     --user-image-dir DIRECTORY
             Directory containing .jpg or .png images of users

diff --git a/data/gource.1 b/data/gource.1
@@ -155,13 +155,13 @@ Duration to keep filenames on screen (>= 2.0).
 Show filename extensions only.
 .TP
 \fB\-\-file\-filter REGEX\fR
-Filter out any files matching a specified regular expression.
+Filter out file paths matching the specified regular expression.
 .TP
 \fB\-\-file\-show\-filter REGEX\fR
-Show only files matching this regular expression.
+Show only file paths matching the specified regular expression.
 .TP
 \fB\-\-user\-filter REGEX\fR
-Filter out any usernames matching a specified regular expression.
+Filter usernames matching the specified regular expression.
 .TP
 \fB\-\-user\-image\-dir DIRECTORY\fR
 Directory containing .jpg or .png images of users (eg 'Full Name.png') to use as avatars.

diff --git a/src/gource_settings.cpp b/src/gource_settings.cpp
@@ -130,8 +130,8 @@ if(extended_help) {
     printf("  --transparent            Make the background transparent\n\n");
 
     printf("  --user-filter REGEX      Ignore usernames matching this regex\n");
-    printf("  --file-filter REGEX      Ignore files matching this regex\n");
-    printf("  --file-show-filter REGEX Show only files matching this regex\n\n");
+    printf("  --file-filter REGEX      Ignore file paths matching this regex\n");
+    printf("  --file-show-filter REGEX Show only file paths matching this regex\n\n");
 
     printf("  --user-friction SECONDS  Change the rate users slow down (default: 0.67)\n");
     printf("  --user-scale SCALE       Change scale of users (default: 1.0)\n");