contrib/texinfo/doc/install-info.1

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