Josh Rabinowitz > Sman > sman-update

Download:
Sman-1.03.tar.gz

Annotate this POD

View/Report Bugs
Source   Latest Release: Sman-1.03_002

NAME ^

sman-update - Perl program to index man pages (for searching with sman program)

SYNOPSIS ^

  % sman-update --conf=/my/dir/sman.conf --verbose

or just

  % sman-update

ABSTRACT ^

 sman-update: [--help] [--config=s] [--rman=s] [--zcat=s] [--col=s]
              [--(no)verbose] [--(no)warn] [--(no)debug] [--index=s]
              [--clearcache]

 Builds index for sman.
  --config=/file/sman.conf     config file to read
  --man='/path/to/man -opt'    path to prog like 'man'
  --zcat='/path/to/zcat -f'    path to prog like 'zcat -f'
  --col='/path/to/col -b'      path to prog like 'col -b'
  --rman='/path/to/rman -opt'  path to prog like 'rman -f XML'
  --verbose/--noverbose        verbosity, default off
  --warn   /--nowarn           warnings from children, default off
  --debug  /--nodebug          debug output, default off
  --clearcache                 clear the cache of converted pages 
  --testfile                   just one file, for testing
  --dryrun  (or -n)            don't write anything to the index.
  --help: this text. For more info, see 'perldoc sman-update'

DESCRIPTION ^

Sman-update creates the index of man pages for the sman program, which searches on that index. By default the index is stored in /var/lib/sman.

Sman-update should be run periodically to keep your sman index in sync with your system's man pages.

Both sman and sman-update search for the first configuration file named sman.conf in /etc, /usr/local/etc/, $HOME, and the directory with sman. If no sman.conf file is found, (or specified through sman or sman-update's -conf option), then the default configuration in /usr/local/etc/sman-defaults.conf will be used.

In all cases command line options take precedence over directives read from configuration files.

SECURITY ^

For increased security, sman-update can be run as a non-priveleged user. To do so, chown the directory /var/lib/sman and its contents to the appropriate user.

AUTHOR ^

Josh Rabinowitz <joshr>

SEE ALSO ^

sman, sman-update, sman.conf

syntax highlighting: