Adjust _bashrc to drop `screen.` from `screen.*` TERMs (for Ubuntu).
[dotfiles-framework.git] / README
1 This package provides automatic synchronization of assorted dotfiles,
2 simplifying the maintnance of a uniform configuration across several
3 hosts.
4
5 The basic implentation was by Steve Kemp at
6   http://dotfiles.repository.steve.org.uk
7
8 To install it, simple replace your ~/.bashrc file with mine (or at
9 least replace the portions dealing with ~.dotfiles).  Whenever you
10 open a bash shell, that code will check for the existence of a
11 ~/.dotfiles directory, and if necessary, download it from my public
12 repository (ideally using git, but it falls back on wgetting a
13 tarball).  It then creates simlinks to any dotfiles that you had been
14 missing automatically.
15
16 After installation, the code in your .bashrc file will check for
17 weekly updates at the central server.  Any updates to the files that
18 it controls (i.e. dotfiles symlinked into ~/.dotfiles/_XXX) will be
19 applied automatically.
20
21 In order to increase your local installation's similarity with the
22 central server, take a look at the differences between your installed
23 dotfiles and those in ~/.dotfile with
24   cd ~/.dotfiles
25   make localdiff | less
26 If you see a few places where you like your local version better, make
27 a patch, and save the hunks in (see *making local.patch* below)
28   ~/.dotfiles/local.patch
29 You can do a dry run of any update with
30   cd ~/.dotfiles && ./fixup.sh --dry-run
31 or overide with
32   cd ~/.dotfiles && ./fixup.sh --dry-run --force
33 Then put .dotfiles in control with
34   make override
35 which will replace all your local dotfiles with their .dotfiles version
36 and then patch them as you specified in local.patch.
37
38
39 Making local.patch
40
41 Set up your installed dotfiles as you want them to be.  (TODO: helper
42 script for partial, interactive merges of the central version.)  Then
43 just
44     make localpatch