| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. |
| 2 |
.TH INSTALL-INFO "1" "March 2026" "GNU texinfo 7.3" "User Commands" |
| 3 |
.SH NAME |
| 4 |
install-info \- update info/dir entries |
| 5 |
.SH SYNOPSIS |
| 6 |
.B install-info |
| 7 |
[\fI\,OPTION\/\fR]... [\fI\,INFO-FILE \/\fR[\fI\,DIR-FILE\/\fR]] |
| 8 |
.SH DESCRIPTION |
| 9 |
Add or remove entries in INFO\-FILE from the Info directory DIR\-FILE. |
| 10 |
INFO\-FILE and DIR\-FILE are required unless the \fB\-\-info\-file\fR |
| 11 |
or \fB\-\-dir\-file\fR (or \fB\-\-info\-dir\fR) options are given, respectively. |
| 12 |
.SH OPTIONS |
| 13 |
.TP |
| 14 |
\fB\-\-add\-once\fR |
| 15 |
add only to first matching section, not all. |
| 16 |
.TP |
| 17 |
\fB\-\-align\fR=\fI\,COL\/\fR |
| 18 |
start description of new entries at column COL. |
| 19 |
.TP |
| 20 |
\fB\-\-calign\fR=\fI\,COL\/\fR |
| 21 |
format second and subsequent description lines to |
| 22 |
start at column COL. |
| 23 |
.TP |
| 24 |
\fB\-\-debug\fR |
| 25 |
report what is being done. |
| 26 |
.TP |
| 27 |
\fB\-\-delete\fR |
| 28 |
delete existing entries for INFO\-FILE from DIR\-FILE; |
| 29 |
don't insert any new entries. |
| 30 |
.TP |
| 31 |
\fB\-\-defsection\fR=\fI\,TEXT\/\fR |
| 32 |
like \fB\-\-section\fR, but only use TEXT if no sections |
| 33 |
are present in INFO\-FILE (replacing "Miscellaneous"). |
| 34 |
.TP |
| 35 |
\fB\-\-description\fR=\fI\,TEXT\/\fR |
| 36 |
the description of the entry is TEXT; used with |
| 37 |
the \fB\-\-name\fR option to become synonymous with the |
| 38 |
\fB\-\-entry\fR option. |
| 39 |
.TP |
| 40 |
\fB\-\-dir\-file\fR=\fI\,NAME\/\fR |
| 41 |
specify file name of Info directory file; |
| 42 |
equivalent to using the DIR\-FILE argument. |
| 43 |
.TP |
| 44 |
\fB\-\-dry\-run\fR |
| 45 |
same as \fB\-\-test\fR. |
| 46 |
.TP |
| 47 |
\fB\-\-entry\fR=\fI\,TEXT\/\fR |
| 48 |
insert TEXT as an Info directory entry, |
| 49 |
overriding any corresponding entry from DIR\-FILE. |
| 50 |
TEXT is written as an Info menu item line followed |
| 51 |
.TP |
| 52 |
by zero or more extra lines starting with whitespace. |
| 53 |
If you specify more than one entry, all are added. |
| 54 |
If you don't specify any entries, they are determined |
| 55 |
.IP |
| 56 |
from information in the Info file itself. |
| 57 |
.TP |
| 58 |
\fB\-\-help\fR |
| 59 |
display this help and exit. |
| 60 |
.TP |
| 61 |
\fB\-\-info\-dir\fR=\fI\,DIR\/\fR |
| 62 |
same as \fB\-\-dir\-file\fR=\fI\,DIR\/\fR/dir. |
| 63 |
.TP |
| 64 |
\fB\-\-info\-file\fR=\fI\,FILE\/\fR |
| 65 |
specify Info file to install in the directory; |
| 66 |
equivalent to using the INFO\-FILE argument. |
| 67 |
.TP |
| 68 |
\fB\-\-item\fR=\fI\,TEXT\/\fR |
| 69 |
same as \fB\-\-entry\fR=\fI\,TEXT\/\fR. |
| 70 |
.TP |
| 71 |
\fB\-\-keep\-old\fR |
| 72 |
do not replace entries, or remove empty sections. |
| 73 |
.TP |
| 74 |
\fB\-\-maxwidth\fR, \fB\-\-max\-width\fR=\fI\,COL\/\fR |
| 75 |
wrap description at column COL. |
| 76 |
.TP |
| 77 |
\fB\-\-menuentry\fR=\fI\,TEXT\/\fR |
| 78 |
same as \fB\-\-name\fR=\fI\,TEXT\/\fR. |
| 79 |
.TP |
| 80 |
\fB\-\-name\fR=\fI\,TEXT\/\fR |
| 81 |
the name of the entry is TEXT; used with \fB\-\-description\fR |
| 82 |
to become synonymous with the \fB\-\-entry\fR option. |
| 83 |
.TP |
| 84 |
\fB\-\-no\-indent\fR |
| 85 |
do not format new entries in the DIR file. |
| 86 |
.TP |
| 87 |
\fB\-\-quiet\fR |
| 88 |
suppress warnings. |
| 89 |
.TP |
| 90 |
\fB\-\-regex\fR=\fI\,R\/\fR |
| 91 |
put this file's entries in all sections that match the |
| 92 |
regular expression R (ignoring case). |
| 93 |
.TP |
| 94 |
\fB\-\-remove\fR |
| 95 |
same as \fB\-\-delete\fR. |
| 96 |
.TP |
| 97 |
\fB\-\-remove\-exactly\fR |
| 98 |
only remove if the info file name matches exactly; |
| 99 |
suffixes such as .info and .gz are not ignored. |
| 100 |
.TP |
| 101 |
\fB\-\-section\fR=\fI\,SEC\/\fR |
| 102 |
put entries in section SEC of the directory. |
| 103 |
If you specify more than one section, all the entries |
| 104 |
.TP |
| 105 |
are added in each of the sections. |
| 106 |
If you don't specify any sections, they are determined |
| 107 |
.TP |
| 108 |
from information in the Info file itself; |
| 109 |
if nothing is available there, the \fB\-\-defsection\fR |
| 110 |
value is used; if that is not specified, the |
| 111 |
final default is "Miscellaneous". |
| 112 |
.TP |
| 113 |
\fB\-\-section\fR R SEC |
| 114 |
equivalent to \fB\-\-regex\fR=\fI\,R\/\fR \fB\-\-section\fR=\fI\,SEC\/\fR \fB\-\-add\-once\fR. |
| 115 |
.TP |
| 116 |
\fB\-\-silent\fR |
| 117 |
suppress warnings. |
| 118 |
.TP |
| 119 |
\fB\-\-test\fR |
| 120 |
suppress updating of DIR\-FILE. |
| 121 |
.TP |
| 122 |
\fB\-\-version\fR |
| 123 |
display version information and exit. |
| 124 |
.SH "REPORTING BUGS" |
| 125 |
Email bug reports to bug\[email protected], |
| 126 |
general questions and discussion to help\[email protected]. |
| 127 |
.br |
| 128 |
Texinfo home page: https://www.gnu.org/software/texinfo/ |
| 129 |
.SH COPYRIGHT |
| 130 |
Copyright \(co 2026 Free Software Foundation, Inc. |
| 131 |
License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html> |
| 132 |
.br |
| 133 |
This is free software: you are free to change and redistribute it. |
| 134 |
There is NO WARRANTY, to the extent permitted by law. |
| 135 |
.SH "SEE ALSO" |
| 136 |
The full documentation for |
| 137 |
.B install-info |
| 138 |
is maintained as a Texinfo manual. If the |
| 139 |
.B info |
| 140 |
and |
| 141 |
.B install-info |
| 142 |
programs are properly installed at your site, the command |
| 143 |
.IP |
| 144 |
.B info install-info |
| 145 |
.PP |
| 146 |
should give you access to the complete manual. |