LSRC(1)

💖 lsrc — show dotfiles files managed by rcm 💖

okay bestie, welcome to lsrc, a lil star from the General Commands Manual, section 1. this one's literally just here to list stuff for you. no cap.

---

✨ SYNOPSIS ✨

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

---

🦋 DESCRIPTION 🦋

so like, this program lists all your configuration files — both the sources chillin' in the dotfiles directories and the destinations over in your home directory. it's giving full picture, honestly.

if you wanna know the whole directory layout situation, go peek at rcup(1), specifically the “DIRECTORY LAYOUT” section. it's all explained there, iykyk.

it supports these options, and yes we're doing all of them, no skipping:

• -B HOSTNAME — treat host-HOSTNAME as the host-specific directory instead of, like, computing it from the computer's actual hostname. main character override energy.
• -d DIR — list dotfiles from the DIR. and guess what, you can say this multiple times. go off.
• -F — show lil symbols next to each file so you know the status. the supported ones are: @ meaning it's a symlink, $ meaning it's a symlinked directory, and X meaning the file is a copy. want the deep lore on copied files and symlinked directories? it's in rcrc(5) under the docs for COPY_ALWAYS and SYMLINK_DIRS, respectively. 💅
• -h — show usage instructions. help a girl out.
• -I excl_pat — include the files matching the given pattern. this gets applied after any -x options. it uses the exact same pattern language as -x; more deets live in the “EXCLUDE PATTERN” section below. heads up tho: you may have to quote the exclude pattern so your shell doesn't go evaluate the glob. 🙈
• -S excl_pat — symlink the directories matching the given pattern. see “EXCLUDE PATTERN” for more. this option can be repeated. and yeah, you might need to quote the pattern so the shell doesn't swallow your glob.
• -s excl_pat — if a directory matches the pattern, recur inside it instead of symlinking. see “EXCLUDE PATTERN”. this is the literal opposite of -S, so you can use it to undo that, or to undo the SYMLINK_DIRS setting in your rcrc(5) config. it can be repeated, and yeah, quote the pattern so your shell doesn't eat it.
• -t TAG — list dotfiles according to TAG. tag yourself, i'm the dotfiles.
• -U excl_pat — the rc files or directories matching this pattern will not be symlinked or created with a leading dot. see “EXCLUDE PATTERN” for the details. this option can be repeated. quote the pattern so the shell doesn't nom the glob.
• -u excl_pat — if an rc file or directory matches the pattern, it must be dotted. see “EXCLUDE PATTERN”. this is the opposite of -U, so you can use it to undo that one, or to undo the UNDOTTED setting in your rcrc(5) config. repeatable! quote it! protect the glob!
• -V — show the version number. gotta know what era we're in.
• -v — increase verbosity. and you can repeat it for extra verbosity. louder. LOUDER.
• -q — decrease verbosity. shhh. 🤫
• -x excl_pat — exclude the files matching the given pattern. see “EXCLUDE PATTERN” for more. this option can be repeated. quote the pattern if it contains a valid shell glob, bestie.
• files ... — only list the specified file(s). that's it. that's the filter.

---

🌈 EXCLUDE PATTERN 🌈

okay this part is important so lock in. an exclude pattern is a colon-separated pair of a dotfiles directory and a file glob. the dotfiles directory part is optional, and if you leave it out it defaults to * — which is a special token that matches any dotfiles directory. the file glob is relative to the dotfiles directory, and it ignores meta directories. a colon is what glues them together.

for example, to ignore all emacs-related items from the thoughtbot-dotfiles directory, use this exclude pattern:

thoughtbot-dotfiles:*emacs*

to ignore any bash_profile file, use this pattern:

*:bash_profile

or, more simply:

bash_profile

and since exclude patterns are often valid shell globs, be sure to quote them. also check the caveats noted in “BUGS” when you're using an exclude pattern. forewarned is forearmed, fr fr.

---

🌸 ENVIRONMENT 🌸

• RCRC — user configuration file. defaults to ~/.rcrc. she lives there. that's her home.

---

🎀 FILES 🎀

~/.dotfiles
~/.rcrc

---

👑 SEE ALSO 👑

mkrc(1), rcdn(1), rcup(1), rcrc(5), rcm(7)

the whole friend group, honestly. slay.

---

💜 AUTHORS 💜

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

protect them at all costs 🫶

---

💀 BUGS 💀

for macOS systems, we strongly encourage the use of the HOSTNAME variable in your rcrc(5).

here's why, bestie: we use the hostname(1) program to figure out the unique identifier for the host. and that program is not specified by POSIX and can vary by system. on macOS the hostname is genuinely unpredictable — it can even change as part of the DHCP handshake. 😭 so yeah. set the variable. save yourself.

---

that's the whole page!! written by the rcm crew, sourced from Debian, dated December 23, 2016, and filed under LSRC(1) in the General Commands Manual. periodt. 💅✨