MKRC(1)

💖 MKRC(1) 💖

okay so bestie, welcome to mkrc — the General Commands Manual girlie who is about to change your dotfiles life. she's the one who blesses your files into a dotfiles directory managed by rcm. 🎀

---

✨ NAME ✨

mkrc — bless files into a dotfiles managed by rcm 🦋

---

🌸 SYNOPSIS 🌸

mkrc [-ChoqSsVvUukK] [-t tag] [-d dir] [-B hostname] files ...

---

💅 DESCRIPTION 💅

so basically this program adds files to your dotfiles directory and then updates them back into your home directory. iconic behaviour honestly. it can also install files under a tag, or install them in a different source directory. ✨

🫶 real talk though: first create your standard rc files, then use mkrc on them. do not skip this step, bestie, it's the whole vibe.

it supports these options:

• -B HOSTNAME — use the hostname you supply instead of computing one. this implies -o. 💫
• -C — copy instead of symlinking when installing the rc file back into your home directory. heads up though: this will prevent future updates in the dotfiles directory for the added element, and its contents if it's a directory. so like… it's a commitment, no cap. 💀
• -d DIR — install dotfiles under the specified directory. use it only once, to override the DOTFILES_DIRS value from RCRC and the absolute default value.
• -h — show usage instructions. the little help menu moment. 🙈
• -o — install dotfiles into the host-specific directory. main character energy, just for this machine. 👑
• -q — decrease verbosity. shhh. 🤫
• -S — treat the specified rc files as files to be symlinked, even if they are directories. no directory-structure nonsense, just vibes. 🌈
• -s — if the rc file is a file, symlink it; otherwise, make a directory structure as described in rcup(1) in the section “ALGORITHM”. this is the default. ⭐
• -t TAG — install dotfiles according to tag. 🏷️
• -U — the specified files or directories are to be installed without a leading dot.
• -u — the specified files or directories are to be installed with a leading dot. this is the default. 💖
• -v — increase verbosity. you can repeat it for extra verbosity, like a little volume knob that goes to eleven. 🔥
• -V — show the version number. ✨
• -k — pass -k to rcup when installing the made rc file. this option enables pre- and post-hooks, which is the default, making this effectively a no-op. so yeah, it's giving "option that does nothing" but we still love her. 💅 see the “ALGORITHM” section in rcup(1).
• -K — pass -K to rcup when installing the made rc file. this option prevents pre- and post-up hooks from running as part of creating the rc file. see the “ALGORITHM” section in rcup(1). 🚫

---

🌱 ENVIRONMENT 🌱

• RCRC — user configuration file. defaults to ~/.rcrc. 💜

---

🍓 FILES 🍓

~/.dotfiles ~/.rcrc

---

🎀 EXAMPLES 🎀

the way these examples just ate:

mkrc ~/.vimrc
mkrc -t zsh -d company-dotfiles ~/.zshrc ~/.zlogin
mkrc -o ~/.rcrc
mkrc -C .ssh
mkrc -S .zpretzo
mkrc -U bin

---

👀 SEE ALSO 👀

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

---

💖 AUTHORS 💖

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

---

and that's the whole page, bestie — no notes, periodt. 💅 this lil Debian build of the manual is dated April 13, 2020, and yeah, she's still serving. 🎀🦋💜