Annotation of OpenXM_contrib/pari/doc/gphelp.1, Revision 1.1
1.1 ! maekawa 1: .TH GPHELP 1 "25 June 1999"
! 2: .SH NAME
! 3: gphelp \- GP-PARI online help script
! 4: .SH SYNOPSIS
! 5: .BR gphelp
! 6: [-to_pod
! 7: .IR file ]
! 8: [-raw]
! 9: [-detex]
! 10: [-k]
! 11: [-ch
! 12: .IR c1 ]
! 13: [-cb
! 14: .IR c2 ]
! 15: [-cu
! 16: .IR c3 ]
! 17: [keyword [ @{1,2,3,4,5} ]]
! 18: [tutorial]
! 19: [refcard]...
! 20: .SH COPYRIGHT
! 21: The PARI/GP package
! 22: is Copyright (C) 1989-1999 by C.Batut, K.Belabas, D.Bernardi, H.Cohen and
! 23: M.Olivier.
! 24:
! 25: .B gphelp
! 26: is free software.
! 27:
! 28: .SH DESCRIPTION
! 29: Invokes the PARI-GP online help script. By default,
! 30: .I keyword
! 31: is understood as a section heading (a GP function name), and
! 32: .B gphelp
! 33: looks for it in Chapter 3 of PARI User's Manual. If it is found, the
! 34: corresponding section is copied to a temporary file in /tmp (or .BR
! 35: $GPTMPDIR ),
! 36: .B TeX
! 37: is run then the corresponding section is displayed in a separate window, using
! 38: .B xdvi
! 39: (or
! 40: .BR $GPXDVI ).
! 41:
! 42:
! 43: If more than one keyword is given on a single command line, the outputs are
! 44: concatenated. If
! 45: .I keyword
! 46: is omitted, open the whole manual
! 47: .IR users.dvi .
! 48: The keywords
! 49: .I tutorial
! 50: and
! 51: .I refcard
! 52: open the GP tutorial and reference card respectively.
! 53:
! 54: GP defaults, help sections (1 to 11) as well as some keywords (readline,
! 55: bnf¸ ell, all operators...) are recognized and treated in a special way to
! 56: make sure they match a section heading. For instance
! 57: .B &&
! 58: is translated to
! 59: .I "Comparison and boolean operators"
! 60: which isn't that obvious to guess.
! 61: Make sure to enclose
! 62: .I keyword
! 63: between quotes if it contains dangerous characters (e.g spaces). For
! 64: instance, you need to type
! 65:
! 66: .RS
! 67: gphelp -k "elliptic curves"
! 68: .RE
! 69:
! 70: and not
! 71:
! 72: .RS
! 73: gphelp -k elliptic curves
! 74: .RE
! 75:
! 76: which would look for
! 77: "elliptic"
! 78: then for
! 79: "curves"
! 80: and output e.g.
! 81: .B ploth
! 82: among the relevant sections.
! 83:
! 84: .SH FULL SEARCH: @ MARKERS
! 85:
! 86: The pattern
! 87: .BR @ x
! 88: (where x is a chapter number between 1 and 5) at the end of
! 89: .I keyword
! 90: conducts the search in the corresponding chapter instead of the default
! 91: Chapter 3. If the number is omitted, search the whole manual. For instance
! 92: .RS
! 93: gphelp -k gerepile@4
! 94: .RE
! 95: will look for
! 96: .B gerepile
! 97: in Chapter 4 of users manual.
! 98: .RS
! 99: gphelp -k gerepile@
! 100: .RE
! 101: will search the whole manual. All chapters of the manual (usersch[1-5].tex)
! 102: are assumed to be in
! 103: .B $GPDOCDIR
! 104: .RI ( /usr/local/lib/pari
! 105: by default). You are allowed to gzip (or compress) them, this won't affect
! 106: the search.
! 107:
! 108: .SH OPTIONS
! 109: The following command line options are available:
! 110: .TP
! 111: .BI -cb,\ -color_bold\ c2
! 112: color used for bold. See
! 113: .BR -color_help .
! 114:
! 115: .TP
! 116: .BI -ch,\ -color_help\ c1
! 117: color (between 1 and 16) used for general printing. Only
! 118: significant in
! 119: .B detex
! 120: mode.
! 121:
! 122: .TP
! 123: .BI -cu,\ -color_underline\ c3
! 124: color used for underline. See
! 125: .BR -color_help .
! 126:
! 127: .TP
! 128: .BI \-detex
! 129: Use
! 130: .B detex
! 131: mode. The TeX file is converted to readable screen output that is directly
! 132: written to the terminal; don't use tex or xdvi.
! 133:
! 134: .TP
! 135: .BI \-k
! 136: Switch to
! 137: .B apropos
! 138: mode. Only write to standard output the list of section headings in manual
! 139: which contain
! 140: .IR keyword .
! 141:
! 142: You can then choose an element in the list and use it as argument for
! 143: .B gphelp
! 144: (surround it by quotes if it includes spaces), possibly followed by a
! 145: trailing
! 146: .B @
! 147: marker (see above).
! 148:
! 149: .TP
! 150: .BI \-raw
! 151: use internal format for output (using @x markers). For debugging only.
! 152:
! 153: .TP
! 154: .BI \-to_pod\ file
! 155: try to convert
! 156: .I file
! 157: from TeX to POD format. Will only work on some subset of PARI User's Manual
! 158: (Chapter 3, reference card). This should be the only arguments on the
! 159: command line.
! 160:
! 161: .SH ENVIRONMENT
! 162: .TP
! 163: COLUMNS
! 164: number of columns available on screen (for
! 165: .B detex
! 166: mode)
! 167:
! 168: .TP
! 169: DISPLAY
! 170: where to launch the dvi previewer. If unset,
! 171: .B detex
! 172: mode is assumed automatically.
! 173:
! 174: .TP
! 175: GPDOCDIR
! 176: directory where PARI help files are located,
! 177: .I /usr/local/lib/pari
! 178: by default.
! 179:
! 180: .TP
! 181: GPTMPDIR
! 182: directory where temporary files are written
! 183:
! 184: .TP
! 185: GPXDVI
! 186: .RS
! 187: dvi previewer to use
! 188: .RE
! 189:
! 190: .SH FILES
! 191: .TP
! 192: .I /usr/local/bin/gp
! 193: the gp calculator
! 194:
! 195: .I /usr/local/bin/gphelp
! 196: the gphelp script
! 197:
! 198: .TP
! 199: .I /usr/local/lib/pari/users.dvi
! 200: PARI/GP User's Manual
! 201:
! 202: .TP
! 203: .I /usr/local/lib/pari/tutorial.dvi
! 204: PARI/GP tutorial
! 205:
! 206: .TP
! 207: .I /usr/local/lib/pari/refcard.dvi
! 208: GP reference card
! 209:
! 210: .TP
! 211: .I /usr/local/lib/pari/refcard.ps
! 212: GP reference card, printer ready
! 213:
! 214: .SH BUGS
! 215:
! 216: The search algorithm is rather crude and the data searched rather
! 217: unstructured. Hence, searching outside of Chapter 3 may not yield useful
! 218: results, except in
! 219: .B apropos
! 220: mode (sections may be truncated too soon for instance).
! 221:
! 222: Multiword search patterns have a tendency to fail due to various TeX
! 223: constructs in the source.
! 224:
! 225: .SH AUTHORS
! 226: Originally written by Ilya Zakharevitch for the Math::Pari perl package.
! 227: Rewritten and expanded by Karim Belabas for the main PARI distribution.
! 228:
! 229: .SH SEE ALSO
! 230: .IR gp (1),
! 231: .IR gzip (1),
! 232: .IR readline (1),
! 233: .IR tex (1),
! 234: .IR xdvi (1).
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to gphelp.1 CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [local] / OpenXM_contrib / pari / doc