summaryrefslogtreecommitdiff
path: root/doc/install-info.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/install-info.1')
-rw-r--r--doc/install-info.1129
1 files changed, 129 insertions, 0 deletions
diff --git a/doc/install-info.1 b/doc/install-info.1
new file mode 100644
index 0000000..47ae5d7
--- /dev/null
+++ b/doc/install-info.1
@@ -0,0 +1,129 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
+.TH INSTALL-INFO "1" "September 2008" "install-info 4.13" "User Commands"
+.SH NAME
+install-info \- update info/dir entries
+.SH SYNOPSIS
+.B install-info
+[\fIOPTION\fR]... [\fIINFO-FILE \fR[\fIDIR-FILE\fR]]
+.SH DESCRIPTION
+Add or remove entries in INFO\-FILE from the Info directory DIR\-FILE.
+.SH OPTIONS
+.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\-\-description\fR=\fITEXT\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=\fINAME\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=\fITEXT\fR
+insert TEXT as an Info directory entry.
+TEXT is written as an Info menu item line followed
+.IP
+by zero or more extra lines starting with whitespace.
+.IP
+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.
+.IP
+When removing, TEXT specifies the entry to remove.
+TEXT is only removed as a last resort, if the
+entry as determined from the Info file is not present,
+and the basename of the Info file isn't found either.
+.TP
+\fB\-\-help\fR
+display this help and exit.
+.TP
+\fB\-\-info\-dir\fR=\fIDIR\fR
+same as \fB\-\-dir\-file\fR=\fIDIR\fR/dir.
+.TP
+\fB\-\-info\-file\fR=\fIFILE\fR
+specify Info file to install in the directory;
+equivalent to using the INFO\-FILE argument.
+.TP
+\fB\-\-item\fR=\fITEXT\fR
+same as \fB\-\-entry\fR=\fITEXT\fR.
+.TP
+\fB\-\-keep\-old\fR
+do not replace entries, or remove empty sections.
+.TP
+\fB\-\-menuentry\fR=\fITEXT\fR
+same as \fB\-\-name\fR=\fITEXT\fR.
+.TP
+\fB\-\-name\fR=\fITEXT\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=\fIR\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=\fISEC\fR
+put entries in section SEC of the directory.
+If you specify more than one section, all the entries
+.IP
+are added in each of the sections.
+.IP
+If you don't specify any sections, they are determined
+.IP
+from information in the Info file itself.
+.TP
+\fB\-\-section\fR R SEC
+equivalent to \fB\-\-regex\fR=\fIR\fR \fB\-\-section\fR=\fISEC\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.
+Texinfo home page: http://www.gnu.org/software/texinfo/
+.SH COPYRIGHT
+Copyright \(co 2008 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.