summaryrefslogtreecommitdiff
path: root/man/mkrc.1
blob: b2809693d29b87f86396e34902928ad712081295 (plain)
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
.Dd July 28, 2013
.Dt MKRC 1
.Os
.Sh NAME
.Nm mkrc
.Nd bless files into a dotfile managed by rcm
.Sh SYNOPSIS
.Nm mkrc
.Op Fl ChoqSsVvUu
.Op Fl t Ar tag
.Op Fl d Ar dir
.Op Fl B Ar hostname
.Ar files ...
.Sh DESCRIPTION
This program adds files to your dotfiles directory then installs it
back into your home directory. It can install files under a tag or
different source directory.
.
It supports these options:
.
.Bl -tag -width "-d DIR"
.It Fl B Ar HOSTNAME
use the supplied hostname instead of computing one. Implies
.Fl o .
.It Fl C
copy instead of symlinking when installing the rc file back into your
home directory
.It Fl d Ar DIR
install dotfiles under the specified directory. This can be specified
multiple times.
.It Fl h
show usage instructions.
.It Fl o
install dotfiles into the host-specific directory
.It Fl q
decrease verbosity
.It Fl S
treat the specified rc files as files to be symlinked, even if they are
directories
.It Fl s
if the rc file is a file, symlink it; otherwise, make a directory
structure as described in
.Xr rcup 1
in the section
.Sx ALGORITHM .
This is the default.
.It Fl t Ar TAG
install dotfiles according to tag
.It Fl U
the specified files or directories are to be installed without a leading
dot.
.It Fl u
the specified files or directories are to be installed with a leading dot. This
is the default.
.It Fl v
increase verbosity. This can be repeated for extra verbosity.
.It Fl V
show the version number.
.El
.Sh ENVIRONMENT
.Bl -tag -width ".Ev RCRC"
.It Ev RCRC
User configuration file. Defaults to
.Pa ~/.rcrc .
.El
.Sh FILES
.Pa ~/.dotfiles
.Pa ~/.rcrc
.Sh EXAMPLES
.Dl mkrc ~/.vimrc
.Dl mkrc -t zsh -d company-dotfiles ~/.zshrc ~/.zlogin
.Dl mkrc -o ~/.rcrc
.Dl mkrc -C .ssh
.Dl mkrc -S .zpretzo
.Dl mkrc -U bin
.Sh SEE ALSO
.Xr lsrc 1 ,
.Xr rcdn 1 ,
.Xr rcup 1 ,
.Xr rcrc 5 ,
.Xr rcm 7
.Sh AUTHORS
.Nm
is maintained by
.An "Mike Burns" Aq Mt mburns@thoughtbot.com
and
.Lk http://thoughtbot.se thoughtbot