annotate man/man1/manaim.1 @ 0:5242703e91d3 tip

Initial checkin for AIM92 aimR8.2 (last updated May 1997).
author tomwalters
date Fri, 20 May 2011 15:19:45 +0100
parents
children
rev   line source
tomwalters@0 1 .TH MANAIM 1 "18 May 1994"
tomwalters@0 2
tomwalters@0 3 .SH NAME
tomwalters@0 4 manaim \- Displays help/manual documentations on-line.
tomwalters@0 5
tomwalters@0 6 .SH SYNTAX
tomwalters@0 7 manaim
tomwalters@0 8 .IR page-title
tomwalters@0 9
tomwalters@0 10 manaim -k
tomwalters@0 11 .IR keyword
tomwalters@0 12
tomwalters@0 13 manaim -F
tomwalters@0 14 .IR filename
tomwalters@0 15
tomwalters@0 16 .SH DESCRIPTION
tomwalters@0 17 This command uses the standard Unix man command. The path for searching man
tomwalters@0 18 pages is the ~release/man directory.
tomwalters@0 19
tomwalters@0 20 The basic function of manaim is to provide on-line displays of AIM reference
tomwalters@0 21 pages. The manaim command formats (using Nroff) and displays one or more
tomwalters@0 22 specified reference/manual pages.
tomwalters@0 23
tomwalters@0 24 For keyword search the
tomwalters@0 25 .IR -k
tomwalters@0 26 option will display one line summary of each command where the string of
tomwalters@0 27 keyword is matched by identical strings in the aim/release/man/whatis file.
tomwalters@0 28
tomwalters@0 29 For filename search the
tomwalters@0 30 .IR -F
tomwalters@0 31 option attempts to locate manual pages related to any of the given filenames,
tomwalters@0 32 and then prints one-line summaries containing the resulting names.
tomwalters@0 33 This option also uses the whatis database.
tomwalters@0 34
tomwalters@0 35
tomwalters@0 36 .SH "EXTENDED OPTION DESCRIPTION"
tomwalters@0 37 Manaim command provides help information about the AIM tools and other
tomwalters@0 38 options. There is another command called listdoc
tomwalters@0 39 .IR file-name,
tomwalters@0 40 which displays long documents on-line (e.g. bibliography), which are not
tomwalters@0 41 necessarily help pages.
tomwalters@0 42
tomwalters@0 43 .SH FILES
tomwalters@0 44 /home/cedar/local/aim/release/script/manaim
tomwalters@0 45
tomwalters@0 46 .SH "SEE ALSO"
tomwalters@0 47 createman(1), enterman(1), editman(1), delman(1) and listscript(1).
tomwalters@0 48
tomwalters@0 49 .SH BUGS
tomwalters@0 50 No bugs yet.
tomwalters@0 51
tomwalters@0 52 .SH EXAMPLES
tomwalters@0 53 For screenful of text:
tomwalters@0 54
tomwalters@0 55 manaim
tomwalters@0 56 .IR ptrain;
tomwalters@0 57 manaim
tomwalters@0 58 .IR fft.
tomwalters@0 59
tomwalters@0 60 For keywords (an apropos command):
tomwalters@0 61
tomwalters@0 62 manaim
tomwalters@0 63 .IR -k
tomwalters@0 64 .IR atob
tomwalters@0 65
tomwalters@0 66 .SH COPYRIGHT
tomwalters@0 67 .LP
tomwalters@0 68 Copyright (c) Applied Psychology Unit, Medical Research Council, 1995
tomwalters@0 69 .LP
tomwalters@0 70 Permission to use, copy, modify, and distribute this software without fee
tomwalters@0 71 is hereby granted for research purposes, provided that this copyright
tomwalters@0 72 notice appears in all copies and in all supporting documentation, and that
tomwalters@0 73 the software is not redistributed for any fee (except for a nominal
tomwalters@0 74 shipping charge). Anyone wanting to incorporate all or part of this
tomwalters@0 75 software in a commercial product must obtain a license from the Medical
tomwalters@0 76 Research Council.
tomwalters@0 77 .LP
tomwalters@0 78 The MRC makes no representations about the suitability of this
tomwalters@0 79 software for any purpose. It is provided "as is" without express or
tomwalters@0 80 implied warranty.
tomwalters@0 81 .LP
tomwalters@0 82 THE MRC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
tomwalters@0 83 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
tomwalters@0 84 THE A.P.U. BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES
tomwalters@0 85 OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
tomwalters@0 86 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
tomwalters@0 87 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
tomwalters@0 88 SOFTWARE.
tomwalters@0 89