Debian Codegraph @

manpage/dotdrop.txt2man

raw
1 NAME
2 dotdrop - save your dotfiles once, deploy them everywhere
3
4 SYNOPSIS
5 dotdrop COMMAND [OPTIONS] [ARGS] ...
6 dotdrop --help
7 dotdrop --version
8
9 DESCRIPTION
10 Dotdrop makes the management of dotfiles between different hosts easy.
11 It allows you to store your dotfiles in Git and automagically deploy
12 different versions of the same file on different setups.
13
14 It also allows manage different sets of dotfiles. For example, you can have
15 a set of dotfiles for your home laptop and a different set for your office
16 desktop. Those sets may overlap, and different versions of the same dotfiles
17 can be deployed using different predefined profiles. Or you may have a main
18 set of dotfiles for your everyday host and a subset you only need to deploy
19 to temporary hosts (cloud VM etc.) that may be using a slightly different
20 version of some of the dotfiles.
21
22 COMMANDS
23 install Install dotfiles
24 -a --force-actions Execute all actions even if no dotfile is installed.
25 -d --dry Dry run.
26 -D --showdiff Show a diff before overwriting.
27 -f --force Do not ask user confirmation for anything.
28 -n --nodiff Do not diff when installing.
29 -p --profile=<profile> Specify the profile to use.
30 -t --temp Install to a temporary directory for review.
31 -w --workers=<nb> Number of concurrent workers [default: 1].
32 -W --workdir-clear Clear the workdir.
33
34 import Import dotfiles
35 -d --dry Dry run.
36 -f --force Do not ask user confirmation for anything.
37 -i --ignore=<pattern> Pattern to ignore.
38 -l --link=<link> Link option (nolink|absolute|relative|link_children).
39 -m --preserve-mode Insert a chmod entry in the dotfile with its mode.
40 -p --profile=<profile> Specify the profile to use.
41 -s --as=<path> Import as a different path from actual path.
42 --transr=<key> Associate trans_install key on import.
43 --transw=<key> Apply trans_update key on import.
44
45 compare Compare dotfiles
46 -C --file=<path> Path of dotfile to compare.
47 -i --ignore=<pattern> Pattern to ignore.
48 -p --profile=<profile> Specify the profile to use.
49 -w --workers=<nb> Number of concurrent workers [default: 1].
50 -z --ignore-missing Ignore files in installed folders that are missing.
51
52 update Update a managed dotfile
53 -d --dry Dry run.
54 -f --force Do not ask user confirmation for anything.
55 -i --ignore=<pattern> Pattern to ignore.
56 -k --key Treat <path> as a dotfile key.
57 -p --profile=<profile> Specify the profile to use.
58 -P --show-patch Provide a one-liner to manually patch template.
59 -w --workers=<nb> Number of concurrent workers [default: 1].
60 -z --ignore-missing Ignore files in installed folders that are missing.
61
62 remove Unmanage a dotfile
63 -d --dry Dry run.
64 -f --force Do not ask user confirmation for anything.
65 -k --key Treat <path> as a dotfile key.
66 -p --profile=<profile> Specify the profile to use.
67
68 files List the managed dotfiles
69 -G --grepable Grepable output.
70 -p --profile=<profile> Specify the profile to use.
71 -T --template Only template dotfiles.
72
73 detail Detail managed dotfiles
74 -p --profile=<profile> Specify the profile to use.
75
76 profiles List all profiles
77 -G --grepable Grepable output.
78
79 GLOBAL OPTIONS
80 -b --no-banner Do not display the banner.
81 -c --cfg=<path> Path to the config.
82 -V --verbose Be verbose.
83
84 EXAMPLES
85 dotdrop install [-VbtfndDaW] [-c <path>] [-p <profile>]
86 [-w <nb>] [<key>...]
87 dotdrop import [-Vbdfm] [-c <path>] [-p <profile>] [-i <pattern>...]
88 [--transr=<key>] [--transw=<key>]
89 [-l <link>] [-s <path>] <path>...
90 dotdrop compare [-LVbz] [-c <path>] [-p <profile>]
91 [-w <nb>] [-C <file>...] [-i <pattern>...]
92 dotdrop update [-VbfdkPz] [-c <path>] [-p <profile>]
93 [-w <nb>] [-i <pattern>...] [<path>...]
94 dotdrop remove [-Vbfdk] [-c <path>] [-p <profile>] [<path>...]
95 dotdrop files [-VbTG] [-c <path>] [-p <profile>]
96 dotdrop detail [-Vb] [-c <path>] [-p <profile>] [<key>...]
97 dotdrop profiles [-VbG] [-c <path>]
98
99 dotdrop --help
100
101 dotdrop --version
102
103 ABOUT
104 More information can be found on the repository under <https://github.com/deadc0de6/dotdrop>
105 and in the main documentation under <https://dotdrop.readthedocs.io>
106
107 AUTHOR
108 Written by deadc0de6 <https://github.com/deadc0de6>
109
110 COPYRIGHT
111 dotdrop is copyright (c) 2017, deadc0de6. Released under the GPLv3 license.
112
113 REPORTING BUGS
114 <https://github.com/deadc0de6/dotdrop/issues>