Penguin
Recent Changes
Blame: install-info(8)
EditPageHistoryDiffInfoLikePages
Annotated edit history of install-info(8) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 INSTALL-INFO
2 !!!INSTALL-INFO
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 SEE ALSO
7 COPYRIGHT
8 ----
9 !!NAME
10
11
12 install-info - create or update entry in Info directory
13 !!SYNOPSIS
14
15
16 __install-info__ [[--version] [[--help] [[--debug]
17 [[--maxwidth=nnn] [[--section regexp title] [[--infodir=xxx]
18 [[--align=nnn] [[--quiet] [[--menuentry=xxx]
19 [[--description=xxx] [[--remove | --remove-exactly ] [[--]
20 filename
21 !!DESCRIPTION
22
23
24 __install-info__ makes, updates or removes entries in the
25 Info directory, the __dir__ file. When updating or
26 creating entries, if no description is specified on the
27 command line or in the Info file it attempts to guess a
28 description from the contents of the file.
29
30
31 See the description of the __--section__ option for
32 details of where the entry will be placed and a description
33 of the expected format of the __dir__ file.
34
35
36 __OPTIONS__
37
38
39 __[[--]__ ''filename''
40
41
42 Gives the filename of the Info file whose menu entry is to
43 be created, updated or removed. If __--remove-exactly__
44 is specified, then ''filename'' should be the exact entry
45 name to be removed (i.e.
46 ''dir__ file (see the
47 __--infodir__ option).
48
49
50 If ''filename'' ends in __.gz__ it is taken to refer
51 to a file compressed with GNU gzip; if it doesn't exist, but
52 a corresponding ''filename''__.gz__ does, the latter
53 is used instead.
54
55
56 When adding or updating entries the file must exist at the
57 path specified (possibly with an additional __.gz__
58 extension).
59
60
61 __--remove__
62
63
64 Specifies that the entry for the file ''filename'' is to
65 be removed; by default entries are created or
66 updated.
67
68
69 If the removal results in a section becoming empty the
70 section heading (and the spare blank line) will be removed
71 as well, unless this is the last section in the file or
72 __--keep-old__ is specified. See the __--section__
73 option for details about the expected format of the
74 __dir__ file.
75
76
77 If there are several suitable entries in the __dir__ file
78 only those in the first matching contiguous group will be
79 removed and the others silently ignored.
80
81
82 It is not an error for no suitable entry to be found, though
83 __install-info__ will issue a warning unless the
84 __--quiet__ option was specified.
85
86
87 When __--remove__ is specified the __--maxwidth__,
88 __--align__ and __--calign__ formatting options are
89 silently ignored.
90
91
92 __--remove-exactly__
93
94
95 This option is essentially the same as __--remove__
96 except that ''filename'' is taken as the exact entry to
97 be removed, rather than as the name of an existing file.
98 This can be important when trying to remove entries that
99 refer to info files in subdirectories (i.e.
100 ''--remove__ will
101 operate on the basename of the given ''filename'' rather
102 than the exact name given. (i.e. __--remove__
103 __install-info__
104 to look for
105 __
106
107
108 __--section__ ''regexp title''
109
110
111 Specifies that, if a new entry is to be made, it should be
112 placed in a section of the __dir__ file whose title
113 matches ''regexp''. If no such section exists one will be
114 created as the second last section in the file (see below),
115 with title ''title''. A section is a part of the
116 __dir__ menu delimited by blank lines; the first line is
117 assumed to be the title.
118
119
120 If a new entry is to be created __install-info__ will
121 attempt to insert it within the section according in
122 alphabetic order; if the entries in the section aren't
123 already sorted the new location within the section will be
124 unpredictable. The order of existing entries will not be
125 changed.
126
127
128 The default is to append new entries to the end of the file.
129 The last section (even if it only consists of the title
130 line) should always exist, to ensure that new sections are
131 created in the right place. The final section should be
132 titled to reflect the fact that Info files with no more well
133 specified location are appended to it.
134
135
136 If there is already an entry for the Info file being
137 installed it is replaced in situ with the new
138 entry.
139
140
141 If a section is specified when removing an entry the section
142 is ignored and a warning is issued.
143
144
145 If a section is requested when adding an entry but the file
146 contains no section headings at all then __install-info__
147 will create both the requested section and a Miscellaneous
148 section at the end of the file.
149
150
151 __--infodir=__''infodir''
152
153
154 Specifies that the __dir__ file is, and the installed
155 copy of the new Info file was, is or will be located in
156 ''infodir''. The default is
157 __/usr/info__.
158
159
160 __--align=__''nnn''
161
162
163 Specifies that the first line of the description should be
164 indented at least ''nnn'' characters; extra spaces will
165 be added as required. If necessary because of the length of
166 the __dir__ menu entry details it may be offset more. The
167 default is 27.
168
169
170 __--calign=__''nnn''
171
172
173 Specifies that the second and subsequent lines of the
174 description should be indented at least ''nnn''
175 characters. The default is 29.
176
177
178 __--maxwidth=__''nnn''
179
180
181 Specifies that the maximum width for the Info file is
182 ''nnn''. This is used when wordwrapping the descriptive
183 text. The default is 79.
184
185
186 __--quiet__
187
188
189 Prevents the usual display of the new menu entry just before
190 it is inserted, and of the messages announcing the
191 replacement and removal of existing entries and the creation
192 and deletion of sections.
193
194
195 __--help__
196
197
198 Causes __install-info__ to display its usage information
199 and exit.
200
201
202 __--version__
203
204
205 Causes __install-info__ to display its version and
206 copyright information and exit.
207
208
209 __--description=__''xxx''
210
211
212 Specifies that the description to use after the menu entry
213 in new or updated entries be ''xxx''. The default is to
214 use the the value specified in the Info file itself; this is
215 found by searching for a section of the form__
216 START-INFO-DIR-ENTRY
217 * Auto-PGP: (auto-pgp). PGP under GNU Emacs.
218 END-INFO-DIR-ENTRY__
219
220
221 If the entry found in the Info file itself extends across
222 several lines, each giving a menu entry, the text found in
223 the file is used verbatim. In this case the alphabetic
224 ordering scheme is turned off, and the entries are inserted
225 at the top of section in question. In this case the
226 __--menuentry__, __--maxwidth__, __--align__,
227 __--calign__ and __--menuentry__ options are
228 ignored.
229
230
231 If there is no __dir__ entry in the file the program will
232 try to find a paragraph early in the file starting __this
233 file documents__. It will capitalise the first character
234 of the remainder, and use that.
235
236
237 It is an error for none of these methods to yield a
238 description.
239
240
241 If a description argument is given when __--remove__ is
242 specified it is ignored and a warning is
243 issued.
244
245
246 __--menuentry=__''xxx''
247
248
249 Specifies that the entry in the menu should be ''xxx''.
250 The default is to use the the value specified in the Info
251 file itself. If this is not present the basename of the Info
252 file is used (any __.info__ is deleted, and the entry is
253 made mixed case). See above for details of the format
254 expected for the menu entry in the Info file.
255
256
257 When removing entries the value of the __--menuentry__
258 option must match the actual menu entry field in the menu
259 item to be removed (case not significant). If
260 __--menuentry__ is omitted no check on the menu entry is
261 done.
262
263
264 __--keep-old__
265
266
267 Inhibits the replacement of existing entries and the removal
268 of empty sections.
269
270
271 If the file being installed alreay has an entry in the
272 directory the old entry will be left alone instead of being
273 replaced; the default is to overwrite any old entry found
274 with the newly generated one.
275
276
277 If __--remove__ is specified __--keep-old__ will
278 prevent the removal of the section heading which would
279 otherwise happen if the section is made empty by the
280 removal.
281
282
283 __--test__
284
285
286 Enables test mode, which inhibits the update of the
287 directory file.
288
289
290 __--debug__
291
292
293 Enables debugging mode, in which the results of some
294 internal processing steps are shown.
295 !!SEE ALSO
296
297
298 emacs(1), info(1), gzip(1)
299 !!COPYRIGHT
300
301
302 Copyright 1994, Ian Jackson. __install-info__ is free
303 software; see the GNU General Public Licence version 2 or
304 later for copying conditions. There is ''no''
305 warranty.
306 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.