manpages/fma.1

   1 .TH FMA 1
   2 .SH NAME
   3 fma \- fast manual access
   4 .SH SYNOPSIS
   5 .B fma
   6 .RI [ section ] " manualpage"
   7 .SH DESCRIPTION
   8 This manual page documents briefly the
   9 .B fma
  10 command.
  11 .PP
  12 \fBfma\fP is a script which allows fast and efficient access to manual pages
  13 through using compression via lzop and display of vim.
  14
  15 fma generates manpages via running 'man <requested_manpage>' and storing
  16 the result in a file with the extension txt in directory $HOME/man. Then
  17 lzop is executed for the file and the output is written to a file with the
  18 additional extension lzo. Afterwards the editor vim is executed with
  19 filetype set to man and using on-the-fly decompressing using lzop again.
  20
  21 So far you did not win any time of course. But if you want to display the
  22 same manpage again the processed manpage already exists in $HOME/man and
  23 can be displayed immediately. If you want to experience the difference
  24 just run 'fma zshall' two times and compare it with 'man zshall' too.
  25 .SH OPTIONS
  26 fma supports the following options:
  27 .TP
  28 .B \-h, \-\-help
  29 Show summary of options.
  30 .TP
  31 .B \-v, \-\-version
  32 Show version of program.
  33 .TP
  34 .B $MANDIR
  35 If the environment variable MANDIR is set the specified directory is taken
  36 for output files instead of the default directory $HOME/man.
  37 .SH USAGE EXAMPLE
  38 .TP
  39 .B % fma zshall
  40 Display manpage zshall (man zshall).
  41 .TP
  42 .B % fma 1 read
  43 Display manpage read of section 1 (man 1 read).
  44 .TP
  45 .B % fma 2 read
  46 Display manpage read of section 2 (man 2 read).
  47 .SH AUTHOR
  48 fma was written by Michael Prokop <mika@grml.org> based on an idea of
  49 Matthias Kopfermann <matthi@grml.org>.
  50 .PP
  51 This manual page was written by Michael Prokop <mika@grml.org>
  52 for the grml project (but may be used by others).