File: xstow.s.pod

package info (click to toggle)
xstow 1.0.0-2.1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,160 kB
  • ctags: 1,216
  • sloc: cpp: 7,218; sh: 1,194; makefile: 196; awk: 26
file content (444 lines) | stat: -rw-r--r-- 10,254 bytes parent folder | download | duplicates (2)
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
=head1 NAME

XStow, replacement for GNU Stow

=head1 SYNOPSIS

xstow        [OPTION ...] PACKAGE

#ifdef ENABLE_STATIC
xstow-static [OPTION ...] PACKAGE

xstow-stow   [OPTION ...] PACKAGE
#endif

=head1 DESCRIPTION

XStow is a replacement of GNU Stow (B<stow>) written in C++. It
supports all features of Stow with some extensions.

XStow as GNU Stow, are programs for managing the installation of software
packages, keeping them separate (/usr/local/stow/emacs
vs. /usr/local/stow/perl, for example) while making them appear to be
installed in the same place (/usr/local).

#ifdef ENABLE_STATIC
By default 3 versions of XStow will be compiled

=over 0

=item B<xstow>

The default binary (dynamically linked)

=item B<xstow-static>

A static version with all enabled features except the ncurses support

=item B<xstow-stow>

A static version with few extensions, which results in a smaller binary.
All features that will blow up the binary and not required for being 
compatible to GNU Stow are disabled.

=back
#endif
=head1 USAGE

xstow [OPTION ...] PACKAGE

Install a package

	xstow foobar

Uninstall package

	xstow -D foobar


=head1 OPTIONS

=over 0

=item B<-dl -debug-level> INT

Set's the debug level. An unsigned integer is accepted. The
default value is 0.

=item B<-dm -debug-module> [ALL|ARG|MAIN|TREE|CPPDIR]

Filter messages from a specific module.


=item B<-h -help> 

Shows a help screen.

=item B<-V -Version>

Displays XStows version number and supported features.

=item B<-n -no>

Do not actually make changes

=item B<-c -conflicts>

Scan for conflicts, implies B<-n>.

=item B<-s -simulate>

Simulate installation. If this option is set permission problems will
be ignored and B<-verbose> will be set to 1.

=item B<-d -dir> DIR

Set stow dir to DIR. The default is the current directory.

=item B<-d -target> DIR

Set target to DIR. The default is the parent of the stow directory.

=item B<-v -verbose> [0|1|2|3]

Increase verboseness. Possible levels are 0,1,2 or 3. Simple setting
B<-v> or B<-verbose> adds 1.

=item B<-D -delete>

Unstow instead of stow. Deinstall the package.

=item B<-R -restow>

The same like B<-delete> followed by an reinstall.

=item B<-ap -absolute-path>

Create symlinks with absolute path names. XStow can always handle
packages which were installed with this option. Installing one package
with absolute path names and one without is no problem. Only the
creation of the symlinks will be affected by this option. This will
cause that if one package is installed with this option and one
without, some of the symlinks of the first package, when they have to
be recreated will be recreated as relative ones. It is not good idea
doing this, even XStow does not have any problems with it.
I<Warning:> Breaks compatibility with Stow!

=item B<-tr -traversable> LINKS

A list of links pointing to directories, that can be ignored.
eg.: /usr/local/man is a link to /usr/local/share/man
I<Warning:> Breaks compatibility with Stow!

=item B<-tkt -tr-keep-targets>

Add the list of traversable links also to the keep targets list. This
prevents the targets of the links from beeing removed by XStow, which
would cause that the traversable link becomes a dead link.

#ifdef ENABLE_FNMATCH
=item B<-tre -tr-auto> PATTERN

Automatically add links which target matches this pattern.
#endif

#ifdef ENABLE_REGEX
=item B<-tre -tr-auto-regex> REGEX

Automatically add links which target matches this pattern.
#endif

=item B<-kd -keep-dirs> DIR

A list of directories, that should not be removed when a package will be
removed. I<Warning:> Breaks compatibility with Stow!

#ifdef ENABLE_FNMATCH
=item B<-i -ignore> PATTERN

Ignore files that matches this pattern.
#endif

#ifdef ENABLE_REGEX
=item B<-ire -ignore-regex> REGEX

Ignore files that matches this expression.
#endif

#ifdef ENABLE_NIGNORE
=item B<-ni -nignore> PATTERN

Ignore everything except file and directories matching this
expression. eg: "systree/bintree systree/headertree".
For using nignore support fnmatch and configration file
support has to be enabled. For more details see xstow.ini(5).
#endif

#ifdef ENABLE_FNMATCH
=item B<-cp -copy> PATTERN

Copy files or directories that matching this pattern.
#endif

#ifdef ENABLE_REGEX
=item B<-cre -copy-regex> REGEX

Copy files or directories that matching this expression.
#endif

=item B<-ifd -i-file-in-dir> DIR/FILE

Ignore this file in this directory. (Relative to the package dir.)

=item B<-cfd -c-file-in-dir> DIR/FILE

Copy this file in this directory. (Relative to the package dir.)

=item B<-sd -stow-dirs> DIR

A list of other stow dirs, that xstow is allowed change

#ifdef ENABLE_FNMATCH
=item B<-sda -sd-auto> PATTERN

Automatically add directories to the list when matching this
expression.
#endif

#ifdef ENABLE_REGEX
=item B<-sde -sd-auto-regex> REGEX

Automatically add directories to the list when matching this
expression.
#endif

=item B<-pd -protect-dirs> DIR

A list of other dirs, that xstow is not allowed change

#ifdef ENABLE_FNMATCH
=item B<-pda -pd-auto> PATTERN

Automatically add directories to the list when matching this
expression.
#endif

#ifdef ENABLE_REGEX
=item B<-pde -pd-auto-regex> REGEX

Automatically add directories to the list when matching this
expression.
#endif

=item B<-pdt -pd-targets> DIRS

A list of dirs, xstow is allowed to change.

=item B<-pta -pdt-add-traversable> DIRS

Automatically add the targets of traversable links to the targets list.

=item B<-f -force>

Skip conflicts if possible.

#ifdef ENABLE_CURSES
=item B<-C -no-curses>

Do not detect the terminal width by using curses.
There is more description at the environment variable section.
#endif

#ifdef ENABLE_INI
=item B<-F file>

Read this configuration file too.
#endif

=back

=head1 RETURN VALUES

=over 0

=item B<0>

On success. 

=item B<1>

On a missspelled call of xstow. 

=item B<2>

If an internal error occoured.

=item B<3>

Installing the package failed of some reason. All the prechecking was
ok, but the execution of the exec list failed.

=item B<4>

Installing a package failed.

=back

=head1 ENVIRONMENT VARIABLES

Since the debugging of the command line parsing can be hard if the
debugging level is set by the command line there are two evironment
variables:

=over 0

=item B<XSTOW_DEBUG_LEVEL>

Same as the B<-debug-level> option.

=item B<XSTOW_DEBUG_MODULE>

Same as the B<-debug-module> option.

Both values will be overwritten by the settings of the command line,
after the command line was parsed.

#ifdef ENABLE_INI
=item B<XSTOW_USE_CURSES> 

Same as the B<-no-curses> option.

In later versions xstow tried detecting the terminal width and height,
by default at the startup routine. Even if this value is only used by
the help screen. The result was:

    $ TERM="" xstow 
    Error opening terminal: unknown.

The error message is reported by the ncurses lib. This can cause problems
if you wan't start xstow as a cron job.
Now xstow tries detecting the terminal width not in it's startup, but
when the help screen is printed out. As an extra option you can set
the environment variable B<XSTOW_USE_CURSES>="0" this will tell xstow
not using curses anyway.
#endif

=back

#ifdef ENABLE_INI
=head1 COFIGURATION FILES

The configuration file xstow.ini can be located in /etc and/or in the 
current stow directory. For possible settings and syntax 
of this file see xstow.ini(5)

In this manpage there are some detailed informations of some special
settings of XStow too. Please read it!
#endif

=head1 EXAMPLES

=head2 Common Usage

As an example we install the ixlib library into the /usr/local/ tree. 

	tar xvfz ixlib-0.96.2.tar.gz
	cd ixlib-0.96.2
	./configure
	make

So far, this was business as usual. 

I<Note:> by default the configure script prepares the application for
beeing installed into /usr/local/. Have a look at configure --help for
more info. 

Now installation is done by not installing ixlib directly into
/usr/local/, we install it into /usr/local/stow/ixlib-0.96.2/.

	make install prefix=/usr/local/stow/ixlib-0.96.2/

The last point is creating all necessare symlinks so that ixlib's
include files can be found by the compiler in
/usr/local/include. Therefore we are using xstow.

	cd /usr/local/stow
	xstow ixlib-0.96.2

And all symlinks will be created.

=head2 Installing XStow by using XStow

After calling the configure script and make, XStow is installed into
the stow directory as I showed it in the upper example.

	make install prefix=/usr/local/stow/xstow-0.1.0

Then you switch to the stow directory and call XStow

	cd /usr/local/stow
	xstow-0.1.0/bin/xstow xstow-0.1.0

That is it.

=head1 COMPATIBLE

=head2 Link Creation

By default XStow is fully Stow compatible. The usage of some of the
advanced features can cause that Stow cannot handle the tree any
more.

=head2 Command Line Options

XStow supports all command line options of Stow. Even it's
format. 

Eg.:
	xstow --verbose=2 foobar


=head1 BUGS

There are some nitty gritty cases, but no known bugs.

=head1 WHY

Stow requires Perl. But what's on systems where no Perl is available,
or not yet installed? I tried compiling Stow with B<perlcc>, but it
failed.

=head1 AUTHORS

XStow was written by Martin Oberzalek <kingleo@gmx.at>.

=head1 COPYING

XStow a replacement of GNU Stow written in C++.	

Copyright (C) 2002-2005 by Martin Oberzalek <kingleo@gmx.at>

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

=head1 SEE ALSO

#ifdef ENABLE_INI
xstow.ini(5) merge-info(1) stow(1)
#else
xstow(1) merge-info(1) stow(1)
#endif

GNU Stow has an excelent documentation. Have a look at the manual.
http://www.gnu.org/software/stow/