1GPHELP(1) General Commands Manual GPHELP(1)
2
6 gphelp - GP-PARI online help script
7
9 gphelp [-to_pod file] [-raw] [-detex] [-noskip] [-utf8] [-k] [-ch c1]
10 [-cb c2] [-cu c3] [keyword [ @{1,2,3,4,5} ]] [tutorial] [refcard]...
11
14 Invokes the PARI-GP online help script. By default, keyword is under‐
15 stood as a section heading (a GP function name), and gphelp looks for
16 it in Chapter 3 of PARI User's Manual. If it is found, the correspond‐
17 ing section is copied to a temporary file in /tmp (or $GPTMPDIR), TeX
18 is run then the corresponding section is displayed in a separate win‐
19 dow, using xdvi (or $GPXDVI).
20 If more than one keyword is given on a single command line, the outputs
23 are concatenated. If keyword is omitted, open the whole manual
24 users.dvi. The keywords tutorial and refcard open the GP tutorial and
25 reference card respectively.
26 GP defaults, help sections (1 to 11) as well as some keywords (read‐
28 line, bnf, ell, all operators...) are recognized and treated in a spe‐
29 cial way to make sure they match a section heading. For instance && is
30 translated to Comparison and boolean operators which isn't that obvious
31 to guess. Make sure to enclose keyword between quotes if it contains
32 dangerous characters (e.g spaces). For instance, you need to type
33 gphelp -k "elliptic curves"
35 and not
37 gphelp -k elliptic curves
39 which would look for "elliptic" then for "curves" and output e.g.
41 ploth among the relevant sections.
42
45 The pattern @x (where x is a chapter number between 1 and 5) at the end
46 of keyword conducts the search in the corresponding chapter instead of
47 the default Chapter 3. If the number is omitted, search the whole man‐
48 ual. For instance
49 gphelp -k gerepile@4
50 will look for gerepile in Chapter 4 of users manual.
51 gphelp -k gerepile@
52 will search the whole manual. All chapters of the manual (user‐
53 sch[1-5].tex) are assumed to be in $GPDOCDIR (defaultvaluesetby Config‐
54 ure). You are allowed to gzip (or compress) them, this won't affect the
55 search.
56
59 The following command line options are available:
60 -cb, -color_bold c2
62 color used for bold. See -color_help.
63 -ch, -color_help c1
66 color (between 1 and 16) used for general printing. Only signif‐
67 icant in detex mode.
68 -cu, -color_underline c3
71 color used for underline. See -color_help.
72 -detex Use detex mode. The TeX file is converted to readable screen
75 output that is directly written to the terminal; don't use tex
76 or xdvi.
77 -noskip
80 By default, the help text is continued when a new section is
81 tagged with a %GPHELPskip marker (on the same line). If this
82 option is set, do not honor markers: end the help text as soon
83 as a new section is started.
84 -utf8 In detex mode, use UTF-8 encoding for characters, .e.g. use é
87 (é) instead of 'e.
88 -k Switch to apropos mode. Only write to standard output the list
91 of section headings in manual which contain keyword.
92 You can then choose an element in the list and use it as argu‐
94 ment for gphelp (surround it by quotes if it includes spaces),
95 possibly followed by a trailing @ marker (see above).
96 -raw use internal format for output (using @x markers). For debugging
99 only.
100 -to_pod file
103 try to convert file from TeX to POD format. Will only work on
104 some subset of PARI User's Manual (Chapter 3, reference card).
105 This should be the only arguments on the command line.
106
109 COLUMNS
110 number of columns available on screen (for detex mode)
111 DISPLAY
114 where to launch the dvi previewer. If unset, detex mode is
115 assumed automatically.
116 GPDOCDIR
119 directory where PARI help files are located. Default value set
120 at Configure time.
121 GPTEX
124 TeX typesetting program to use
125 GPTMPDIR
128 directory where temporary files are written
129 GPXDVI
132 dvi previewer to use. You may use this to specify options for
133 vanilla xdvi, for instance "xdvi -s 7" to select a shrink fac‐
134 tor.
135
138 gp the gp calculator
139 gphelp the gphelp script
142 users.dvi
145 PARI/GP User's Manual
146 tutorial.dvi
149 PARI/GP tutorial
150 refcard.dvi
153 GP reference card
154 refcard.ps
157 GP reference card, printer ready
158
161 The search algorithm is rather crude and the data searched rather
162 unstructured. Hence, searching outside of Chapter 3 may not yield use‐
163 ful results, except in apropos mode (sections may be truncated too soon
164 for instance).
165 Multiword search patterns have a tendency to fail due to various TeX
167 constructs in the source.
168
171 Originally written by Ilya Zakharevitch for the Math::Pari perl pack‐
172 age. Rewritten and expanded by Karim Belabas for the main PARI distri‐
173 bution.
174
177 gp(1), gzip(1), readline(1), tex(1), xdvi(1).
178
181 This program is free software; you can redistribute it and/or
182 modify it under the terms of the GNU General Public License as pub‐
183 lished by the Free Software Foundation.
184 This program is distributed in the hope that it will be useful, but
186 WITHOUT ANY WARRANTY; without even the implied warranty of MER‐
187 CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Gen‐
188 eral Public License for more details.
189 You should have received a copy of the GNU General Public License
191 along with this program; if not, write to the Free Software Founda‐
192 tion, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
193 02 February June 2012 GPHELP(1)