summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Mike Burns <mike@mike-burns.com>2014-03-06 13:43:26 +0100
committerGravatar Mike Burns <mike@mike-burns.com>2014-03-10 16:21:47 +0100
commit937e565856a05a32060a43d2ee695443cf6c6af1 (patch)
tree9abed1275fe6c1dd6bf192a0dd8750288e443e17
parentaede2fce719a9895b3ec58254df8308339d76241 (diff)
Document that you must quote globs
The shell likes to expand globs as conveniently as possible. Therefore, quote them when passing them to lsrc(1) and others (e.g. `-x '*vim*'`).
-rw-r--r--man/lsrc.115
1 files changed, 10 insertions, 5 deletions
diff --git a/man/lsrc.1 b/man/lsrc.1
index ad4368f..22920f4 100644
--- a/man/lsrc.1
+++ b/man/lsrc.1
@@ -54,12 +54,14 @@ options. It uses the same pattern language as
.Fl x ;
more details are in the
.Sx EXCLUDE PATTERN
-section.
+section. Note that you may have to quote the exclude pattern so the
+shell does not evaluate the glob.
.
.It Fl S Ar excl_pat
-symlink the directory that match the given pattern. See
+symlink the directories that match the given pattern. See
.Sx EXCLUDE PATTERN
-for more details. This option can be repeated.
+for more details. This option can be repeated. You may need to quote the
+pattern to prevent the shell from swallowing the glob.
.
.It Fl t Ar TAG
list dotfiles according to TAG
@@ -73,7 +75,8 @@ decrease verbosity
.It Fl x Ar excl_pat
exclude the files that match the given pattern. See
.Sx EXCLUDE PATTERN
-for more details. This option can be repeated.
+for more details. This option can be repeated. Quote the pattern if it
+contains a valid shell glob.
.
.It Ar files ...
only list the specified file(s)
@@ -104,7 +107,9 @@ Or more simply:
.Pp
.Dl bash_profile
.Pp
-See the caveats noted in
+.
+Since exclude patterns are often valid shell globs, be sure to quote
+them. See the caveats noted in
.Sx BUGS
when using an exclude pattern.
.Sh ENVIRONMENT