manpages/qma.1

   1 .TH FMA 1
   2 .SH NAME
   3 qma \- quick manual access
   4 .SH SYNOPSIS
   5 .B qma
   6 .RI "[ section ] manualpage [ keyword ]"
   7 .SH DESCRIPTION
   8 This manual page documents briefly the
   9 .B qma
  10 command.
  11 .PP
  12 \fBqma\fP is a script which allows quick and efficient access to manual pages
  13 through using compression via lzop and display of vim.
  14
  15 qma 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 'qma zshall' two times and compare it with 'man zshall' too.
  25
  26 If you want to jump to a special keyword inside the manpage use it as
  27 last option of the qma commandline. Searching for the keyword is done
  28 case insensitive inside vim.
  29 .SH OPTIONS
  30 qma supports the following options:
  31 .TP
  32 .B \-h, \-\-help
  33 Show summary of options.
  34 .TP
  35 .B \-v, \-\-version
  36 Show version of program.
  37 .TP
  38 .B $MANDIR
  39 If the environment variable MANDIR is set the specified directory is taken
  40 for output files instead of the default directory $HOME/man.
  41 .SH USAGE EXAMPLE
  42 .TP
  43 .B % qma zshall
  44 Display manpage zshall (man zshall).
  45 .TP
  46 .B % qma 1 read
  47 Display manpage read of section 1 (man 1 read).
  48 .TP
  49 .B % qma 2 read
  50 Display manpage read of section 2 (man 2 read).
  51 .TP
  52 .B % qma grml overview
  53 Display manpage grml and jump to keyword "overview".
  54 .SH AUTHOR
  55 qma was written by Michael Prokop <mika@grml.org> based on an idea of
  56 Matthias Kopfermann <matthi@grml.org>.
  57 .PP
  58 This manual page was written by Michael Prokop <mika@grml.org>
  59 for the grml project (but may be used by others).