lsrc(1) - f36

1LSRC(1)                   BSD General Commands Manual                  LSRC(1)
2

NAME

4     lsrc — show dotfiles files managed by rcm
5

SYNOPSIS

7     lsrc [-FhqVv] [-B hostname] [-d dir] [-I excl_pat] [-S excl_pat]
8          [-s excl_pat] [-t tag] [-U excl_pat] [-u excl_pat] [-x excl_pat]
9          [files ...]
10

DESCRIPTION

12     This program lists all configuration files, both the sources in the dot‐
13     files directories and the destinations in your home directory.  See
14     rcup(1), the DIRECTORY LAYOUT section, for details on the directory lay‐
15     out.  It supports these options:
16
17     -B HOSTNAME  treat host-HOSTNAME as the host-specific directory instead
18                  of computing it based on the computer's hostname
19
20     -d DIR       list dotfiles from the DIR. This can be specified multiple
21                  times.
22
23     -F           show symbols next to each file indicating status informa‐
24                  tion. Supported symbols are @ which indicates that the file
25                  is a symlink, $ which indicates it's a symlinked directory,
26                  and X to indicate that the file is a copy. More details on
27                  copied files and symlinked directories can be found in
28                  rcrc(5) under the documentation on COPY_ALWAYS and
29                  SYMLINK_DIRS, respectively.
30
31     -h           show usage instructions.
32
33     -I excl_pat  include the files that match the given pattern. This is
34                  applied after any -x options. It uses the same pattern lan‐
35                  guage as -x; more details are in the EXCLUDE PATTERN sec‐
36                  tion. Note that you may have to quote the exclude pattern so
37                  the shell does not evaluate the glob.
38
39     -S excl_pat  symlink the directories that match the given pattern. See
40                  EXCLUDE PATTERN for more details. This option can be
41                  repeated. You may need to quote the pattern to prevent the
42                  shell from swallowing the glob.
43
44     -s excl_pat  if a directory matches the given pattern, recur inside of it
45                  instead of symlinking. See EXCLUDE PATTERN for more details.
46                  This is the opposite of the -S option, and can be used to
47                  undo it or the SYMLINK_DIRS setting in your rcrc(5) configu‐
48                  ration. It can be repeated, and the pattern may need to be
49                  quoted to protect it from your shell.
50
51     -t TAG       list dotfiles according to TAG
52
53     -U excl_pat  the rc files or directories matching this pattern will not
54                  be symlinked or created with a leading dot. See EXCLUDE
55                  PATTERN for more details. This option can be repeated. You
56                  may need to quote the pattern to prevent the shell from
57                  swallowing the glob.
58
59     -u excl_pat  if an rc file or directory matches the given pattern, it
60                  must be dotted. See EXCLUDE PATTERN for more details. This
61                  is the opposite of the -U option, and can be used to undo it
62                  or the UNDOTTED setting in your rcrc(5) configuration. This
63                  option can be repeated. You may need to quote the pattern to
64                  prevent the shell from swallowing the glob.
65
66     -V           show the version number.
67
68     -v           increase verbosity. This can be repeated for extra ver‐
69                  bosity.
70
71     -q           decrease verbosity
72
73     -x excl_pat  exclude the files that match the given pattern. See EXCLUDE
74                  PATTERN for more details. This option can be repeated. Quote
75                  the pattern if it contains a valid shell glob.
76
77     files ...    only list the specified file(s)
78

EXCLUDE PATTERN

80     The exclude pattern specifies a colon-separated pair of dotfiles direc‐
81     tory and file glob. The dotfiles directory is optional and, if omitted,
82     defaults to *, which is a special token that matches any dotfiles direc‐
83     tory. The file glob is relative to the dotfiles directory, ignoring meta
84     directories. A colon combines them.
85
86     For example, to ignore all emacs-related items from the
87     thoughtbot-dotfiles directory, use the exclude pattern:
88
89           thoughtbot-dotfiles:*emacs*
90
91     To ignore any bash_profile file, use the pattern:
92
93           *:bash_profile
94
95     Or more simply:
96
97           bash_profile
98
99     Since exclude patterns are often valid shell globs, be sure to quote
100     them. See the caveats noted in BUGS when using an exclude pattern.
101

ENVIRONMENT

103     RCRC  User configuration file. Defaults to ~/.rcrc.
104

FILES

106     ~/.dotfiles ~/.rcrc
107

AUTHORS

112     lsrc is maintained by Mike Burns <mburns@thoughtbot.com> and thoughtbot:
113     http://thoughtbot.se
114

BUGS

116     For macOS systems, we strongly encourage the use of the HOSTNAME variable
117     in your rcrc(5).  We use the hostname(1) program to determine the unique
118     identifier for the host. This program is not specified by POSIX and can
119     vary by system. On macOS the hostname is unpredictable, and can even
120     change as part of the DHCP handshake.
121
122BSD                            December 23, 2016                           BSD