1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
|
rcm
===
This is a management suite for dotfiles. **See [the tutorial][rcm7] to get
started quickly.**
It assumes that you have a separate dotfiles directory, or are
interested in creating one.
The programs provided are [rcup(1)][rcup1], [mkrc(1)][mkrc1], [rcdn(1)][rcdn1],
and [lsrc(1)][lsrc1]. They are explained in [the tutorial][rcm7] and configured
using [rcrc(5)][rcrc5].
Installation
------------
Alpine Linux:
sudo apk add rcm
Arch Linux:
https://aur.archlinux.org/packages/rcm/
Debian (see further down for Ubuntu):
wget -qO - https://apt.thoughtbot.com/thoughtbot.gpg.key | sudo apt-key add -
echo "deb https://apt.thoughtbot.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/thoughtbot.list
sudo apt-get update
sudo apt-get install rcm
Fedora:
sudo dnf install rcm
FreeBSD:
sudo pkg install rcm
Gentoo:
emerge app-admin/rcm
Korora:
64-bit Korora 23:
sudo dnf copr enable seeitcoming/rcm fedora-23-x86_64
sudo dnf install rcm
Korora is similar to Fedora but with [an additional version and architecture
specification][copr-fedora-korora]. Replace `fedora-23-x86_64` as
appropriate.
[copr-fedora-korora]: https://kororaproject.org/about/news/when-adding-a-copr-repo-to-korora-fails
macOS with Homebrew:
brew install rcm
macOS with MacPorts:
port install rcm
OpenBSD:
doas pkg_add rcm
openSUSE/RHEL/CentOS: [instructions](http://software.opensuse.org/download.html?project=utilities&package=rcm)
Ubuntu (19.04 or later):
sudo apt update
sudo apt install rcm
Ubuntu (12.04, 14.04, 16.04, 18.04, or 18.10):
sudo apt-get install software-properties-common
sudo add-apt-repository ppa:martin-frost/thoughtbot-rcm
sudo apt-get update
sudo apt-get install rcm
Void Linux:
sudo xbps-install -S rcm
Elsewhere:
This uses the standard GNU autotools, so it's the normal dance:
curl -LO https://thoughtbot.github.io/rcm/dist/rcm-1.3.3.tar.gz &&
sha=$(sha256 rcm-1.3.3.tar.gz | cut -f1 -d' ') &&
[ "$sha" = "935524456f2291afa36ef815e68f1ab4a37a4ed6f0f144b7de7fb270733e13af" ] &&
tar -xvf rcm-1.3.3.tar.gz &&
cd rcm-1.3.3 &&
./configure &&
make &&
sudo make install
For more, see `INSTALL`.
Programs
--------
* [rcup(1)][rcup1] is the main program. It is used to install and update
dotfiles, with support for tags, host-specific files, and multiple source
directories.
* [rcdn(1)][rcdn1] is the opposite of [rcup(1)][rcup1].
* [mkrc(1)][mkrc1] is for introducing a dotfile into your dotfiles directory,
with support for tags and multiple source directories.
* [lsrc(1)][lsrc1] shows you all your dotfiles and where they would be
symlinked to. It is used by [rcup(1)][rcup1] but is provided for your own
use, too.
[rcup1]: http://thoughtbot.github.io/rcm/rcup.1.html
[mkrc1]: http://thoughtbot.github.io/rcm/mkrc.1.html
[rcdn1]: http://thoughtbot.github.io/rcm/rcdn.1.html
[lsrc1]: http://thoughtbot.github.io/rcm/lsrc.1.html
[rcm7]: http://thoughtbot.github.io/rcm/rcm.7.html
[rcrc5]: http://thoughtbot.github.io/rcm/rcrc.5.html
Support
-------
Pull requests welcome; see `CONTRIBUTING.md`.
License
-------
Copyright 2013 Mike Burns. BSD license.
Copyright 2014-2015 thoughtbot. BSD license.
## About thoughtbot

RCM is maintained and funded by thoughtbot, inc.
The names and logos for thoughtbot are trademarks of thoughtbot, inc.
We adore open source software.
See [our other projects][community].
We are [available for hire][hire].
[community]: https://thoughtbot.com/community?utm_source=github
[hire]: https://thoughtbot.com/hire-us?utm_source=github
|