Package: dotfiles
dotfilesis a tool to make managing your dotfile symlinks in$HOMEeasy, allowing you to keep all your dotfiles in a single directory.Hosting is up to you. You can use a VCS like git, Dropbox, or even rsync to
distribute your dotfiles repository across multiple hosts.The repository can be specified at runtime, so you can manage multiple
repositories without hassle. See theConfigurationsection below for further
details.Directories are supported as well. Any file object in your home directory that
starts with a.is fair game.Interface-a,--add<file...>Add dotfile(s) to the repository.-c,--checkCheck for missing or unsynced dotfiles.-l,--listList currently managed dotfiles, one per line.-r,--remove<file...>Remove dotfile(s) from the repository.-s,--sync[file...]Update dotfile symlinks. You can overwrite colliding files with-for--force.  All dotfiles are assumed if you do not specify any files to
this command.-m,--move<path>Move dotfiles repository to another location, updating all symlinks in the
process.For all commands you can use the--dry-runoption, which will print actions
and won’t modify anything on your drive.InstallationTo install dotfiles, simply:$ pip install dotfilesOr, if you absolutely must:$ easy_install dotfilesBut, you really shouldn’t do that.If you want to work with the latest version, you can install it fromthe
repository:$ git clone https://github.com/jbernard/dotfiles
$ cd dotfiles
$ ./bin/dotfiles --helpExamplesTo install your dotfiles on a new machine, you might do this:$ git clone https://github.com/me/my-dotfiles Dotfiles
$ dotfiles --syncTo add ‘~/.vimrc’ to your repository:$ dotfiles --add ~/.vimrc     (relative paths work also)To make it available to all your hosts:$ cd ~/Dotfiles
$ git add vimrc
$ git commit -m "Added vimrc, welcome aboard!"
$ git pushYou get the idea. Typedotfiles--helpto see the available options.ConfigurationYou can choose to create a configuration file to store personal customizations.
By default,dotfileswill look for~/.dotfilesrc. You can change this
with the-Cflag. An example configuration file might look like:[dotfiles]
repository = ~/Dotfiles
ignore = [
    '.git',
    '.gitignore',
    '*.swp']
externals = {
    '.bzr.log':     '/dev/null',
    '.uml':         '/tmp'}You can also store your configuration file inside your repository. Put your
settings in.dotfilesrcat the root of your repository anddotfileswill
find it. Note thatignoreandexternalsare appended to any values
previously discovered.PrefixesDotfiles are stored in the repository with no prefix by default. So,~/.bashrcwill link to~/Dotfiles/bashrc. If your files already have a
prefix,.is common, but I’ve also seen_, then you can specify this
in the configuration file anddotfileswill do the right thing. An example
configuration in~/.dotfilesrcmight look like:[dotfiles]
prefix = .ExternalsYou may want to link some dotfiles to external locations. For example,bzrwrites debug information to~/.bzr.logand there is no easy way to disable
it. For that, I link~/.bzr.logto/dev/null. Since/dev/nullis
not within the repository, this is called an external. You can have as many of
these as you like. The list of externals is specified in the configuration
file:[dotfiles]
externals = {
    '.bzr.log':     '/dev/null',
    '.adobe':       '/tmp',
    '.macromedia':  '/tmp'}IgnoresIf you’re using a VCS to manage your repository of dotfiles, you’ll want to
telldotfilesto ignore VCS-related files. For example, I usegit, so
I have the following in my~/.dotfilesrc:[dotfiles]
ignore = [
    '.git',
    '.gitignore',
    '*.swp']Any file you list inignorewill be skipped. Theignoreoption supports
glob file patterns.PackagesMany programs store their configuration in~/.config. It’s quite cluttered
and you probably don’t want to keep all its content in your repository. For this
situation you can use thepackagessetting:[dotfiles]
packages = ['config']This tellsdotfilesthat the contents of theconfigsubdirectory of
your repository must be symlinked to~/.config. If for example you have a
directoryconfig/awesomein your repository, it will be symlinked to~/.config/awesome.This feature allows one additional level of nesting, but further subdirectories
are not eligible for being a package.  For example,configis valid, butconfig/transmissionis not valid.  Arbitrary nesting is a feature under
current consideration.At the moment, packages can not be added or removed through the command line
interface.  They must be constructed and configured manually.  Once this is
done,sync,list,check, andmovewill do the right thing.
Support foraddandremoveis a current TODO item.ContributeIf you’d like to contribute, simply forkthe repository, commit your changes,
make sure tests pass, and send a pull request. Go ahead and add yourself toAUTHORSor I’ll do it when I merge your changes.LicenseISC License.Copyright (c) 2011-2014, Jon Bernard <jbernard@tuxion.com>

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.History0.6.4Add no_dot_prefix optionFix error in syntax for missing repo messageExpands ~’s in config file path0.6.3Prevent adding toplevel package directories (bugfix)Only replace existing dotfiles on remove operation (bugfix)0.6.2Fix single-sync in python 3.x (map is lazy)Fix sync –force regressionFix unit tests to exit with the correct return code0.6.1Add ability to sync only specified filesCreate non-existent package directoriesMention using Dropbox to synchronize a dotfiles repository0.6.0Add “packages” featureAdd –dry-run optionMuch needed code cleanup0.5.6Restore python 3 compatibility0.5.5Add support for Windows symlinks with Python 20.5.4More Python 3 fixes0.5.3Update remaining references to ‘unmanaged’Allow ~ in configuration file external targetsMake source compatible with Python 3Add specific Python version trove classifiers0.5.2Improve wording of “unmanaged” with “unsynced”Fix adding a directory with a trailing slashMention support for directories in documentation0.5.1Fix license formatting0.5.0Add support for in-repo configuration files0.4.4Restore python 2.5 compatibility0.4.3Add glob style pattern support for the ignore option0.4.2Fix bug when syncing an unmanaged directory symlink