File: merge-info.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 (146 lines) | stat: -rw-r--r-- 3,764 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
=head1 NAME

merge-info, merge and unmerge GNU Info index files

=head1 SYNOPSIS

merge-info        [OPTION ...] FILE FILE

=head1 DESCRIPTION

merge-info can merge and unmerge the GNU Info index files named
'dir'. These files are usally created by B<install-info> at install time
of an application, or automatically generated by a B<mkinfodir> script.

If you are installing 2 packages at two different locations, two
different 'dir' files are created. Eg.: One in

	  /stow/foo/usr/local/info/dir 

and one in

	  /stow/bar/usr/local/info/dir 

This is the common case if you are using a tool like
xstow(1). B<merge-info> can handle this and can merge both 'dir'
files and creates a new 'dir' file.

=head1 USAGE

merge-info [OPTION ...] FILE FILE

Merge two files:
      
      merge-info /stow/foo/info/dir /stow/bar/info/dir

Remove the content of a 'dir' file from another 'dir' file

       merge-info -u /stow/foo/info/dir /stow/bar/info/dir

=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<-h -help> 

Shows a help screen.

=item B<-V -Version>

Displays the verion number of the XStow package. B<merge-info> is
shipped with B<xstow>(1).

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

Do not detect the terminal width by using curses.
#endif

=item B<-u -unmerge>

Unmerge instead of merge. Note: It is not possible splitting up one
'dir' file into two. But removing the content of one 'dir' file from
the other one is possible.

=item B<-o -outfile>

Write the resulting 'dir' file not to stdout. Write it to a given
file. Since B<merge-info> does not open this outfile until all the
merging or unmerging stuff is done it is allowed that the outfile is
one the source files. eg.:

    merge-info -u foo/info/dir bar/info/dir -o foo/info/dir

=item B<-d -duplicate>

Remove duplicate entries. When merging 2 files an entry can appear in
more than one section. If you do not wan't this, use this option.

=back

=head1 ENVIRONMENT VARIABLES

=over 0

=item B<XSTOW_DEBUG_LEVEL>

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


#ifdef ENABLE_CURSES
=item B<XSTOW_USE_CURSES> 

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

In previous 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.

merge-info has the same behaviour.
#endif

=back

=head1 AUTHORS

merge-info was written by Martin Oberzalek <kingleo@gmx.at>.

=head1 COPYING

merge-info, a tool for merging GNU Info index files.	

Copyright (C) 2004-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

info(1) install-info(1) xstow(1)