summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/install-info.1
blob: f438aacac28a8036c9cb00a76f26b82da314eb20 (plain)
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
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.1.
.TH INSTALL-INFO "1" "October 2023" "GNU texinfo 7.1" "User Commands"
.SH NAME
install-info \- update info/dir entries
.SH SYNOPSIS
.B install-info
[\fI\,OPTION\/\fR]... [\fI\,INFO-FILE \/\fR[\fI\,DIR-FILE\/\fR]]
.SH DESCRIPTION
Add or remove entries in INFO\-FILE from the Info directory DIR\-FILE.
INFO\-FILE and DIR\-FILE are required unless the \fB\-\-info\-file\fR
or \fB\-\-dir\-file\fR (or \fB\-\-info\-dir\fR) options are given, respectively.
.SH OPTIONS
.TP
\fB\-\-add\-once\fR
add only to first matching section, not all.
.TP
\fB\-\-align\fR=\fI\,COL\/\fR
start description of new entries at column COL.
.TP
\fB\-\-calign\fR=\fI\,COL\/\fR
format second and subsequent description lines to
start at column COL.
.TP
\fB\-\-debug\fR
report what is being done.
.TP
\fB\-\-delete\fR
delete existing entries for INFO\-FILE from DIR\-FILE;
don't insert any new entries.
.TP
\fB\-\-defsection\fR=\fI\,TEXT\/\fR
like \fB\-\-section\fR, but only use TEXT if no sections
are present in INFO\-FILE (replacing "Miscellaneous").
.TP
\fB\-\-description\fR=\fI\,TEXT\/\fR
the description of the entry is TEXT; used with
the \fB\-\-name\fR option to become synonymous with the
\fB\-\-entry\fR option.
.TP
\fB\-\-dir\-file\fR=\fI\,NAME\/\fR
specify file name of Info directory file;
equivalent to using the DIR\-FILE argument.
.TP
\fB\-\-dry\-run\fR
same as \fB\-\-test\fR.
.TP
\fB\-\-entry\fR=\fI\,TEXT\/\fR
insert TEXT as an Info directory entry,
overriding any corresponding entry from DIR\-FILE.
TEXT is written as an Info menu item line followed
.TP
by zero or more extra lines starting with whitespace.
If you specify more than one entry, all are added.
If you don't specify any entries, they are determined
.IP
from information in the Info file itself.
.TP
\fB\-\-help\fR
display this help and exit.
.TP
\fB\-\-info\-dir\fR=\fI\,DIR\/\fR
same as \fB\-\-dir\-file\fR=\fI\,DIR\/\fR/dir.
.TP
\fB\-\-info\-file\fR=\fI\,FILE\/\fR
specify Info file to install in the directory;
equivalent to using the INFO\-FILE argument.
.TP
\fB\-\-item\fR=\fI\,TEXT\/\fR
same as \fB\-\-entry\fR=\fI\,TEXT\/\fR.
.TP
\fB\-\-keep\-old\fR
do not replace entries, or remove empty sections.
.TP
\fB\-\-maxwidth\fR, \fB\-\-max\-width\fR=\fI\,COL\/\fR
wrap description at column COL.
.TP
\fB\-\-menuentry\fR=\fI\,TEXT\/\fR
same as \fB\-\-name\fR=\fI\,TEXT\/\fR.
.TP
\fB\-\-name\fR=\fI\,TEXT\/\fR
the name of the entry is TEXT; used with \fB\-\-description\fR
to become synonymous with the \fB\-\-entry\fR option.
.TP
\fB\-\-no\-indent\fR
do not format new entries in the DIR file.
.TP
\fB\-\-quiet\fR
suppress warnings.
.TP
\fB\-\-regex\fR=\fI\,R\/\fR
put this file's entries in all sections that match the
regular expression R (ignoring case).
.TP
\fB\-\-remove\fR
same as \fB\-\-delete\fR.
.TP
\fB\-\-remove\-exactly\fR
only remove if the info file name matches exactly;
suffixes such as .info and .gz are not ignored.
.TP
\fB\-\-section\fR=\fI\,SEC\/\fR
put entries in section SEC of the directory.
If you specify more than one section, all the entries
.TP
are added in each of the sections.
If you don't specify any sections, they are determined
.TP
from information in the Info file itself;
if nothing is available there, the \fB\-\-defsection\fR
value is used; if that is not specified, the
final default is "Miscellaneous".
.TP
\fB\-\-section\fR R SEC
equivalent to \fB\-\-regex\fR=\fI\,R\/\fR \fB\-\-section\fR=\fI\,SEC\/\fR \fB\-\-add\-once\fR.
.TP
\fB\-\-silent\fR
suppress warnings.
.TP
\fB\-\-test\fR
suppress updating of DIR\-FILE.
.TP
\fB\-\-version\fR
display version information and exit.
.SH "REPORTING BUGS"
Email bug reports to bug\-texinfo@gnu.org,
general questions and discussion to help\-texinfo@gnu.org.
.br
Texinfo home page: http://www.gnu.org/software/texinfo/
.SH COPYRIGHT
Copyright \(co 2023 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
The full documentation for
.B install-info
is maintained as a Texinfo manual.  If the
.B info
and
.B install-info
programs are properly installed at your site, the command
.IP
.B info install-info
.PP
should give you access to the complete manual.