1MGP(1) BSD General Commands Manual MGP(1)
2
4 mgp — MagicPoint -- an X11 based presentation tool
5
7 mgp [-dhlnoqvBCGORSV] [-b bgcolor] [-c vfcap] [-f vfont] [-g geometry]
8 [-p page] [-t timeslot] [-w wdir] [-x engine] [-D htmldir]
9 [-E htmlimage] [-F mode,effect,value] [-Q quality] [-T timestampfile]
10 [-X gsdevice] file
11
13 mgp is an X11 based presentation tool. It is designed to make simple
14 presentations easy while to make complicated presentations possible. Its
15 presentation file (whose suffix is typically .mgp) is just text so that
16 you can create presentation files quickly with your favorite editor (such
17 as Emacs).
18
19 The .mgp file consists of text and control commands (such as pagebreak,
20 centering, and/or inline image). Control commands are specified on the
21 beginning of lines started with one % sign. You can include numerous
22 kinds of image format files onto the presentation file.
23
24 mgp uses Japanese/English fonts in various sizes. mgp uses X11 scalable
25 fonts provided by X11 servers. mgp can also utilize the Japanese outline
26 font library, "VFlib", if configured to do so at compilation time.
27
28 The following options are available:
29
30 -b bgcolor
31 Set background color to bgcolor. (The default value is black)
32
33 -c vfcap
34 Specify a VFlib configuration file.
35
36 -d [interval]
37 Demonstration mode. Browse all page automatically, spending
38 interval secounds on each page and terminate. If interval is not
39 specified, it will be set to 0.
40
41 -f vfont
42 Specify the font name to be used by VFlib. (The default value is
43 minsl)
44
45 -g geometry
46 Set the size and location of the window. Please note that -g
47 implies -o. mgp will not override the window manager if you spec‐
48 ify the geometry.
49
50 -h Display the usage and exit without performing a presentation.
51
52 -l There are two kind of fonts available by VFlib; They are outline
53 font and bitmap font. By specifying -l, you can disable the use
54 of outline fonts.
55
56 -n mgp accepts any key inputs from invoked terminal as KEY OPERATION
57 described below. -n disables this feature. (This option may be
58 removed in the future release)
59
60 -o Do not override window manager. (By default, mgp overrides win‐
61 dow manager and occupies the whole display)
62
63 -p page
64 Start presentation from page, rather than the first page.
65
66 -q Do not beep on errors.
67
68 -t timeslot
69 Specify the timeslot assigned to the presentation in minute. The
70 timer is invoked when the second page is displayed and the
71 remaining presentation time is indicated by the length of bar
72 shown at the bottom of the display. The timebar is updated when
73 some X11 event is raised, for instance some keypress. Timebar
74 will be green if you have more than 50% of the timeslot, yellow
75 while you have more than 30% of the timeslot, and red for the
76 other cases. When the assigned timeslot is expired, exceeding
77 time is also shown as a timebar growing from left to right. Cur‐
78 rent page is indicated by the position of a small vertical bar;
79 the vertical bar is drawn at the leftend when the first page is
80 displayed while the bar is drawn at the rightend when the last
81 page is displayed.
82
83 --title name
84 Set the title of the window to name.
85
86 -v Display the MagicPoint version and exit without performing a pre‐
87 sentation.
88
89 -w wdir
90 specifies the working directory used for store embedded images if
91 any. To generate an embedded MGP file, use mgpembed(1).
92
93 -x engine
94 Do not use rendering engine, specified by engine. engine can be
95 VFlib or FreeType.
96
97 -B Omit background image.
98
99 -C Use private colormap.
100
101 -D htmldir
102 Generate html pages of the presentation into htmldir. You will
103 need xwintoppm(1) (included in mgp kit), and pnmscale(1),
104 cjpeg(1), and djpeg(1) (included in netpbm and Independent Jpeg
105 Group jpeg package).
106
107 -E htmlimage
108 Specifies html image type. Now "jpg" and "png" are supported.
109 default value is "jpg". It works when -D option is set.
110
111 -F mode,effect,value
112 Specifies forward page cache options. Mode, effect and value are
113 numbers. Mode specifies caching mode. Mode 0 means caching is
114 executed after 2 seconds idle. Mode 1 means caching is executed
115 immediately. Effect specifies 'special effect' for the forward
116 page cache. Currently, two special effects are supported. Effect
117 1 means that the next page will come in from the left side.
118 Effect 2 means that the current page will go out to the left
119 side. Effect 0 means no special effect. Value specifies speed
120 of special effect. Value 1 means the highest speed. A higher
121 value for value decreases effect speed.
122
123 -G Specifies to turn on page guide function. At the bottom of the
124 screen, the titles of next page and previous page are displayed
125 to assist the presentation. Page guide can be turned on and off
126 by keyboard too.
127
128 -O Obey to the window manager, but with less decoration around the
129 window. The behavior of this option is affected by how the win‐
130 dow manager is implemented; this option may have no effect on
131 some of the window managers.
132
133 -Q quality
134 Set background image quality(0-100).
135
136 -R mgp will usually reload the presentation file if it gets updated,
137 based on the file modification time taken by stat(2). -R dis‐
138 ables this auto-reloading feature.
139
140 -S Be secure. Skip directives that fork/exec the child process. It
141 is suggested to use this option if you got some presentation file
142 from others. This is enabled by default.
143
144 -U Be unsecure. Enable directives that fork/exec the child process.
145 Allow to use non-ASCII filename.
146
147 -T timestampfile
148 If the option is specified, mgp will modify the content of
149 timestampfile every time it updates the presentation window.
150 This option is useful for external process to understand when mgp
151 modifies the window.
152
153 -V Be verbose. Generate debugging output to standard output.
154
155 -X gsdevice
156 mgp sometimes invokes ghostscript(1) to render postscript images.
157 -X enables you to specify the device to be used by
158 ghostscript(1). If you specify gsdevice with a trailing '+',
159 pnmscale(1) and pnmdepth(1) will be invoked for anti-aliasing.
160 The default gsdevice is "pnmraw+".
161
163 The keyboard/mouse commands are:
164
165 mouse button 1 (leftmost button)
166 Go forward a page. Space key, downward cursor key, scroll down
167 key, "f" key, "j" key, and "n" key have the same effect. If
168 <number> is specified, go forward <number> pages.
169
170 mouse button 3 (rightmost button)
171 Go to the previous page. "b" key, "k" key, "p" key, backspace
172 key, scroll up key and upward cursor key have the same effect.
173 If <number> is specified, go back <number> pages.
174
175 0 - 9 (number buttons)
176 Set prefix number in decimal. i.e. <number> = <number> * 10 +
177 <keyN> - <key0>. For example, by typing in "10g" you can jump to
178 page 10.
179
180 g Go to the <number> page. If number of 0 is specified, go to the
181 last page.
182
183 control key
184 Display the page listing menu. See below for details.
185
186 G Enable/disable page guide. See description for option -G for
187 details.
188
189 x Enable/disable rakugaki (jotting) mode. You can make an annota‐
190 tion (by mouse) on the presentation. Mouse button 2 (middle) has
191 the same effect.
192
193 X Change the pen color for rakugaki (jotting) mode.
194
195 t Enable/disable the timebar if -t timeslot option is specified.
196
197 c Enable/disable forward page cache.
198
199 w Toggle full screen mode with EWMH. (You need a EWMH-aware window
200 manager and need to run mgp with -o or -g option)
201
202 control-L
203 Repaint the current page. Use this if you messed up the page by
204 jotting too much.
205
206 control-R
207 Reload the current presentation file. If the current page
208 becomes unavailable, page pointer will be moved back to 1.
209
210 escape key
211 Quit the currently running mgp. "q" key also has the same
212 effect.
213
214 During the presentation, you can see the page list at the bottom of the
215 window when you press a Control Key. Choosing a page with the mouse and
216 clicking it with the leftmost mouse button, you can go to corresponding
217 page directly. Releasing the Control Key, the page list disappears and
218 you can continue with the current page. This function is useful during
219 the Q-and-A period after your presentation completes.
220
222 mgp will look at a file named ~/.mgprc in your home directory. The path
223 to this file can be overriden with the environment variable MGPRC. The
224 content of the file must be a limited set of magicpoint directives, one
225 directive per line, without % sign. Lines start with #, or empty lines,
226 will be silently ignored. See SYNTAX for eligible directives.
227
228 mgp imports various image draw functions from xloadimage(1). This means
229 that the location of image files can be specified by ~/.xloadimagerc
230 file. If you specify the presentation file with its directory, that
231 directory is searched first and then the path specified in the
232 ~/.xloadimagerc is searched.
233
235 MGPRC Full path of the configuration file. When unset, ~/.mgprc is
236 used.
237
239 The presentation file can include directives to call the external
240 process, just like shell process. Therefore, the presentation file
241 should be treated just like shell script or perl script. This is
242 STRONGLY recommended to review the content of the presentation file
243 before invoking mgp, if you got the file from others. By adding the -S
244 option to the command line argument, directives that call external pro‐
245 cesses will be skipped.
246
248 mgp2ps(1), xloadimage(1), mgpembed(1)
249
251 Yoshifumi Nishida <nishida@csl.sony.co.jp>
252
254 Jun-ichiro Hagino <itojun@itojun.org>, Akira Kato <kato@wide.ad.jp>,
255 Atsushi Onoe <onoe@sm.sony.co.jp>, Kazu Yamamoto <Kazu@Mew.org>, Youjiro
256 Uo <yuo@nui.org>, and Masaki Minami <Masaki@Minami.org> extensively con‐
257 tributed improvements, bug fixes, and documents. Special thanks to Chaki
258 Kusakari <chaki@sfc.wide.ad.jp>.
259
261 mgp was created shortly after the autumn camp of WIDE Project in 1997,
262 which was originally called tp (TinyPoint).
263
264BSD June 20, 2019 BSD