Quick ?s
Cheat Sheets
Man Pages
The Lynx
install-info(8) 		dpkg utilities		       install-info(8)

       install-info - create or update entry in Info directory

       install-info [--version] [--help] [--debug] [--maxwidth=nnn] [--section
       regexp title] [--infodir=xxx] [--align=nnn] [--quiet] [--menuentry=xxx]
       [--description=xxx] [--remove|--remove-exactly] [--] filename

       install-info  makes,  updates or removes entries in the Info directory,
       the dir file. When updating or creating entries, if no  description  is
       specified  on the command line or in the Info file it attempts to guess
       a description from the contents of the file.

       See the description of the --section option for details	of  where  the
       entry  will  be	placed and a description of the expected format of the
       dir file.

       [--] filename
	      Gives the filename of the Info file whose menu entry  is	to  be
	      created,	updated  or removed. If --remove-exactly is specified,
	      then filename should be the exact entry name to be removed (i.e.
	      "emacs-20/emacs" or "gcc"), otherwise the basename of this file
	      name is used as the referent of the menu entry which is created,
	      unless  theres  an  overriding  START-INFO-DIR entry inside the
	      given file. This file must therefore exist (or be  about	to  be
	      installed, or have previously existed when removing an entry) in
	      the same directory as the dir file (see the --infodir option).

	      If filename ends in .gz it is taken to  refer  to  a  file  com
	      pressed  with GNU gzip; if it doesnt exist, but a corresponding
	      filename.gz does, the latter is used instead.

	      When adding or updating entries the file must exist at the  path
	      specified (possibly with an additional .gz extension).

	      Specifies that the entry for the file filename is to be removed;
	      by default entries are created or updated.

	      If the removal results in a section becoming empty  the  section
	      heading  (and  the  spare  blank	line) will be removed as well,
	      unless this is the last section in the  file  or	--keep-old  is
	      specified.  See  the  --section  option  for  details  about the
	      expected format of the dir file.

	      If there are several suitable entries in the dir file only those
	      in  the  first matching contiguous group will be removed and the
	      others silently ignored.

	      It is not an error for no suitable entry	to  be	found,	though
	      install-info  will issue a warning unless the --quiet option was

	      When --remove is specified the --maxwidth, --align and  --calign
	      formatting options are silently ignored.

	      This  option  is	essentially  the  same as --remove except that
	      filename is taken as the exact entry to be removed, rather  than
	      as  the  name  of  an  existing file. This can be important when
	      trying to remove entries that refer to info files in subdirecto
	      ries  (i.e.  "emacs-20/emacs")  because --remove will operate on
	      the basename of the given filename rather than  the  exact  name
	      given. (i.e.  --remove "emacs-20/emacs" would cause install-info
	      to look for "emacs", not "emacs-20/emacs").

       --section regexp title
	      Specifies that, if a new entry is  to  be  made,	it  should  be
	      placed  in a section of the dir file whose title matches regexp.
	      If no such section exists one will be created as the second last
	      section in the file (see below), with title title.  A section is
	      a part of the dir menu delimited by blank lines; the first  line
	      is assumed to be the title.

	      If  a  new  entry  is to be created install-info will attempt to
	      insert it within the section according in alphabetic  order;  if
	      the  entries  in the section arent already sorted the new loca
	      tion within the section will  be	unpredictable.	The  order  of
	      existing entries will not be changed.

	      The default is to append new entries to the end of the file. The
	      last section (even if it only consists of the title line) should
	      always  exist,  to  ensure  that new sections are created in the
	      right place.  The final section should be titled to reflect  the
	      fact  that  Info	files with no more well specified location are
	      appended to it.

	      If there is already an entry for the Info file  being  installed
	      it is replaced in situ with the new entry.

	      If  a section is specified when removing an entry the section is
	      ignored and a warning is issued.

	      If a section is requested when adding an entry but the file con
	      tains  no  section headings at all then install-info will create
	      both the requested section and a Miscellaneous  section  at  the
	      end of the file.

	      Specifies  that  the  dir file is, and the installed copy of the
	      new Info file was, is  or  will  be  located  in	infodir.   The
	      default is /usr/share/info/.

       --align=nnn [deprecated]
	      Specifies  that  the  first  line  of  the description should be
	      indented at least nnn characters; extra spaces will be added  as
	      required.  If  necessary	because  of the length of the dir menu
	      entry details it may be offset more. The default is 27.

       --calign=nnn [deprecated]
	      Specifies that the second and subsequent lines of  the  descrip
	      tion  should be indented at least nnn characters. The default is

       --maxwidth=nnn [deprecated]
	      Specifies that the maximum width for the Info file is nnn.  This
	      is used when word-wrapping the descriptive text.	The default is

	      Prevents the usual display of the new menu entry just before  it
	      is  inserted, and of the messages announcing the replacement and
	      removal of existing entries and the  creation  and  deletion  of

       --help Causes install-info to display its usage information and exit.

	      Causes  install-info to display its version and copyright infor
	      mation and exit.

	      Specifies that the description to use after the  menu  entry  in
	      new  or  updated	entries be xxx.  The default is to use the the
	      value specified in the  Info  file  itself;  this  is  found  by
	      searching for a section of the form
	      * Auto-PGP: (auto-pgp). PGP under GNU Emacs.

	      If  the  entry found in the Info file itself extends across sev
	      eral lines, each giving a menu entry, the text found in the file
	      is used verbatim. In this case the alphabetic ordering scheme is
	      turned off, and the entries are inserted at the top  of  section
	      in  question. In this case the --menuentry, --maxwidth, --align,
	      --calign	and --menuentry options are ignored.

	      If there is no dir entry in the file the	program  will  try  to
	      find a paragraph early in the file starting this file documents.
	      It will capitalise the first character of the remainder, and use

	      It is an error for none of these methods to yield a description.

	      If a description argument is given when --remove is specified it
	      is ignored and a warning is issued.

	      Specifies that the entry in the menu should be xxx.  The default
	      is to use the the value specified in the Info file  itself.   If
	      this  is	not present the basename of the Info file is used (any
	      .info is deleted, and the entry is made mixed case).  See  above
	      for  details  of	the  format expected for the menu entry in the
	      Info file.

	      When removing entries the value of the --menuentry  option  must
	      match the actual menu entry field in the menu item to be removed
	      (case not significant). If --menuentry is omitted  no  check  on
	      the menu entry is done.

	      Inhibits	the replacement of existing entries and the removal of
	      empty sections.

	      If the file being installed already has an entry in  the	direc
	      tory the old entry will be left alone instead of being replaced;
	      the default is to overwrite any old entry found with  the  newly
	      generated one.

	      If  --remove is specified --keep-old will prevent the removal of
	      the section heading which would otherwise happen if the  section
	      is made empty by the removal.

       --test Enables  test  mode,  which inhibits the update of the directory

	      Enables debugging mode, in which the results  of	some  internal
	      processing steps are shown.

       emacs(1), info(1), gzip(1).

       Copyright  1994,  Ian  Jackson.	install-info is free software; see the
       GNU General Public Licence version 2 or later for  copying  conditions.
       There is no warranty.

Debian Project			  2006-02-28		       install-info(8)

Yals.net is © 1999-2009 Crescendo Communications
Sharing tech info on the web for more than a decade!
This page was generated Thu Apr 30 17:05:31 2009