-
Notifications
You must be signed in to change notification settings - Fork 12
/
unco.1
237 lines (237 loc) · 6.54 KB
/
unco.1
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "unco 1"
.TH unco 1 "2014-04-07" "0.1.0" "LOCAL\ USER\ COMMANDS"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Unco \- undo any command
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& # record changes to files made by cmd
\& % unco record \-\- cmd args
\&
\& # display a list of recorded commands
\& % unco history
\&
\& # undo a recorded change
\& % unco undo <index>
\&
\& # redo a recorded change
\& % undo redo <index>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Unco is a wrapper program that records the changes made to files by programs so
that they can be undone laterwards.
.PP
It uses a technique called library preloading (for more information consult the
linux documents with keyword \s-1LD_PROLOAD\s0, or os x document with keyword
\&\s-1DYLD_INSERT_LIBRARIES\s0) to trap the library calls that affect the files, and
records the changes made by the programs being executed.
.SH "INSTALLATION"
.IX Header "INSTALLATION"
.Vb 3
\& cmake .
\& make
\& make install
.Ve
.SH "SUB-COMMANDS"
.IX Header "SUB-COMMANDS"
.SS "unco record"
.IX Subsection "unco record"
.Vb 1
\& % unco record [\-\-log=<path>] [\-\-append] \-\- cmd args
.Ve
.PP
The command executes given command while logging the changes.
.PP
\fI\-\-log=<path>\fR
.IX Subsection "--log=<path>"
.PP
specifies the location of the log (if omitted, the log is stored under
\&\f(CW$HOME\fR/.unco with appropriate index)
.PP
\fI\-\-append\fR
.IX Subsection "--append"
.PP
used together with \-\-log for appending the changes to the log (default
behavior is truncate)
.SS "unco history"
.IX Subsection "unco history"
.Vb 1
\& % unco history [\-\-ppid=<pid>] [\-\-cmd=<cmd>] [\-\-cwd=<dir>]
.Ve
.PP
Displays the list of recorded commands with their associated indices.
.PP
\fI\-\-ppid=<pid>\fR
.IX Subsection "--ppid=<pid>"
.PP
filters the output to commands that were spawned by given process id. If
omitted, the default value is the process id that spawned the history command,
so that only the records belonging to the current shell are being displayed.
Set \-1 as the argument to display all records.
.PP
\fI\-\-cmd=<cmd>\fR
.IX Subsection "--cmd=<cmd>"
.PP
filters the output to commands starting with given prefix
.PP
\fI\-\-cwd=<cwd>\fR
.IX Subsection "--cwd=<cwd>"
.PP
filters the output to commands that were spawn under given working directory
.SS "unco undo"
.IX Subsection "unco undo"
.Vb 1
\& % unco undo [\-\-print] <index_or_path>
.Ve
.PP
Undoes a recorded change. The argument is the index number displayed by
\&\*(L"unco history\*(R" or path pointing to a unco record.
.PP
\fI\-\-print\fR
.IX Subsection "--print"
.PP
displays the changes to be performed instead of actually applying them
.SS "unco redo"
.IX Subsection "unco redo"
.Vb 1
\& % unco redo [\-\-print] <index_or_path>
.Ve
.PP
Redoes a recorded change that has been undone. The index is the number
displayed by \*(L"unco history\*(R" or path pointing to a unco record.
.SH "AUTHOR"
.IX Header "AUTHOR"
Kazuho Oku <https://github.com/kazuho/>
.SH "LICENSE"
.IX Header "LICENSE"
\&\s-1MIT\s0