[BACK]Return to gphelp.1 CVS log [TXT][DIR] Up to [local] / OpenXM_contrib / pari-2.2 / doc

Annotation of OpenXM_contrib/pari-2.2/doc/gphelp.1, Revision 1.1.1.1

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>