man-pages/man1/install-info.1.html
2021-03-31 01:06:50 +01:00

168 lines
5.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of INSTALL-INFO</TITLE>
</HEAD><BODY>
<H1>INSTALL-INFO</H1>
Section: User Commands (1)<BR>Updated: September 2019<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
install-info - update info/dir entries
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>install-info</B>
[<I>,OPTION/</I>]... [<I>,INFO-FILE /</I>[<I>,DIR-FILE/</I>]]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
Add or remove entries in INFO-FILE from the Info directory DIR-FILE.
INFO-FILE and DIR-FILE are required unless the <B>--info-file</B>
or <B>--dir-file</B> (or <B>--info-dir</B>) options are given, respectively.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<DL COMPACT>
<DT id="1"><B>--add-once</B><DD>
add only to first matching section, not all.
<DT id="2"><B>--align</B>=<I>,COL/</I><DD>
start description of new entries at column COL.
<DT id="3"><B>--calign</B>=<I>,COL/</I><DD>
format second and subsequent description lines to
start at column COL.
<DT id="4"><B>--debug</B><DD>
report what is being done.
<DT id="5"><B>--delete</B><DD>
delete existing entries for INFO-FILE from DIR-FILE;
don't insert any new entries.
<DT id="6"><B>--defsection</B>=<I>,TEXT/</I><DD>
like <B>--section</B>, but only use TEXT if no sections
are present in INFO-FILE (replacing &quot;Miscellaneous&quot;).
<DT id="7"><B>--description</B>=<I>,TEXT/</I><DD>
the description of the entry is TEXT; used with
the <B>--name</B> option to become synonymous with the
<B>--entry</B> option.
<DT id="8"><B>--dir-file</B>=<I>,NAME/</I><DD>
specify file name of Info directory file;
equivalent to using the DIR-FILE argument.
<DT id="9"><B>--dry-run</B><DD>
same as <B>--test</B>.
<DT id="10"><B>--entry</B>=<I>,TEXT/</I><DD>
insert TEXT as an Info directory entry,
overriding any corresponding entry from DIR-FILE.
TEXT is written as an Info menu item line followed
<DT id="11">by zero or more extra lines starting with whitespace.<DD>
If you specify more than one entry, all are added.
If you don't specify any entries, they are determined
<DT id="12"><DD>
from information in the Info file itself.
<DT id="13"><B>--help</B><DD>
display this help and exit.
<DT id="14"><B>--info-dir</B>=<I>,DIR/</I><DD>
same as <B>--dir-file</B>=<I>,DIR/</I>/dir.
<DT id="15"><B>--info-file</B>=<I>,FILE/</I><DD>
specify Info file to install in the directory;
equivalent to using the INFO-FILE argument.
<DT id="16"><B>--item</B>=<I>,TEXT/</I><DD>
same as <B>--entry</B>=<I>,TEXT/</I>.
<DT id="17"><B>--keep-old</B><DD>
do not replace entries, or remove empty sections.
<DT id="18"><B>--maxwidth</B>, <B>--max-width</B>=<I>,COL/</I><DD>
wrap description at column COL.
<DT id="19"><B>--menuentry</B>=<I>,TEXT/</I><DD>
same as <B>--name</B>=<I>,TEXT/</I>.
<DT id="20"><B>--name</B>=<I>,TEXT/</I><DD>
the name of the entry is TEXT; used with <B>--description</B>
to become synonymous with the <B>--entry</B> option.
<DT id="21"><B>--no-indent</B><DD>
do not format new entries in the DIR file.
<DT id="22"><B>--quiet</B><DD>
suppress warnings.
<DT id="23"><B>--regex</B>=<I>,R/</I><DD>
put this file's entries in all sections that match the
regular expression R (ignoring case).
<DT id="24"><B>--remove</B><DD>
same as <B>--delete</B>.
<DT id="25"><B>--remove-exactly</B><DD>
only remove if the info file name matches exactly;
suffixes such as .info and .gz are not ignored.
<DT id="26"><B>--section</B>=<I>,SEC/</I><DD>
put entries in section SEC of the directory.
If you specify more than one section, all the entries
<DT id="27">are added in each of the sections.<DD>
If you don't specify any sections, they are determined
<DT id="28">from information in the Info file itself;<DD>
if nothing is available there, the <B>--defsection</B>
value is used; if that is not specified, the
final default is &quot;Miscellaneous&quot;.
<DT id="29"><B>--section</B> R SEC<DD>
equivalent to <B>--regex</B>=<I>,R/</I> <B>--section</B>=<I>,SEC/</I> <B>--add-once</B>.
<DT id="30"><B>--silent</B><DD>
suppress warnings.
<DT id="31"><B>--test</B><DD>
suppress updating of DIR-FILE.
<DT id="32"><B>--version</B><DD>
display version information and exit.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>REPORTING BUGS</H2>
Email bug reports to <A HREF="mailto:bug-texinfo@gnu.org">bug-texinfo@gnu.org</A>,
general questions and discussion to <A HREF="mailto:help-texinfo@gnu.org">help-texinfo@gnu.org</A>.
<BR>
Texinfo home page: <A HREF="http://www.gnu.org/software/texinfo/">http://www.gnu.org/software/texinfo/</A>
<A NAME="lbAG">&nbsp;</A>
<H2>COPYRIGHT</H2>
Copyright &#169; 2019 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later &lt;<A HREF="http://gnu.org/licenses/gpl.html">http://gnu.org/licenses/gpl.html</A>&gt;
<BR>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
The full documentation for
<B>install-info</B>
is maintained as a Texinfo manual. If the
<B>info</B>
and
<B>install-info</B>
programs are properly installed at your site, the command
<DL COMPACT>
<DT id="33"><DD>
<B>info install-info</B>
</DL>
<P>
should give you access to the complete manual.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="34"><A HREF="#lbAB">NAME</A><DD>
<DT id="35"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="36"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="37"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="38"><A HREF="#lbAF">REPORTING BUGS</A><DD>
<DT id="39"><A HREF="#lbAG">COPYRIGHT</A><DD>
<DT id="40"><A HREF="#lbAH">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:17 GMT, March 31, 2021
</BODY>
</HTML>