update forward page cache docs master
authormirabilos <t.glaser@tarent.de>
Tue, 30 Jul 2019 15:12:22 +0000 (17:12 +0200)
committermirabilos <mirabilos@evolvis.org>
Tue, 30 Jul 2019 15:12:22 +0000 (17:12 +0200)
USAGE
draw.c
mgp.1
mgp.c

diff --git a/USAGE b/USAGE
index 1c2e35f..de99e7d 100644 (file)
--- a/USAGE
+++ b/USAGE
@@ -97,7 +97,7 @@ In other words,
 3 tabs mean text size 3% and the line starts with spaces and white delta icon.
 
 
-By using this, it's easy to itemize. Let's take a look at an example:
+By using this, it's easy to itemise. Let's take a look at an example:
 
        %page
 
@@ -212,8 +212,8 @@ package(ftp://ftp.dcs.ed.ac.uk/pub/ajcd).
     same configuration as "the real thing".  It will make rendering
     faster.  (For the included EPS images, pixel image will be
     generated and be cached).  If you execute "mgp" with the "-F"
-    option, "mgp" fetches and caches the next page so that it makes
-    faster to visualize the next page.
+    option (e.g. "mgp -F 1"), "mgp" fetches and caches the next page
+    so that it makes faster to visualise the next page.
 
     NOTE: this means mgp will leave around files named similarily to
     .gscache.dad.eps.446x133 (.gscache. + original filename + . + size)
diff --git a/draw.c b/draw.c
index 730e683..c04b09f 100644 (file)
--- a/draw.c
+++ b/draw.c
@@ -209,8 +209,8 @@ state_next(struct render_state *state)
                if (state->page < maxpage) {
                        purgechild(state->page);
                        clear_zimage(state->page);
-                       if (mgp_flag & FL_FRDCACHE &&
-                               cached_page == state->page + 1) {
+                       if ((mgp_flag & FL_FRDCACHE) &&
+                               (cached_page == state->page + 1)) {
                                        /* Hit cache */
                                        set_from_cache(state);
                                        pcache_process(state->page);
diff --git a/mgp.1 b/mgp.1
index f2a5140..015aa97 100644 (file)
--- a/mgp.1
+++ b/mgp.1
 .Op Fl D Ar htmldir
 .Op Fl d Op Ar interval
 .Op Fl E Ar htmlimage
-.Op Fl F Ar mode,effect,value
+.Oo
+.Fl F
+.Ar mode Ns Oo
+.Ar ,effect Ns Op Ar ,value
+.Oc
+.Oc
 .Op Fl g Ar geometry
 .Op Fl p Ar page
 .Op Fl Q Ar quality
@@ -117,7 +122,11 @@ are supported, default value is
 It works when the
 .Fl D
 option is set.
-.It Fl F Ar mode,effect,value
+.It Xo
+.Fl F Ar mode Ns Oo
+.Ar ,effect Ns Op Ar ,value
+.Oc
+.Xc
 Specifies forward page cache options.
 .Ar Mode ,
 .Ar effect
diff --git a/mgp.c b/mgp.c
index 5e10990..aae891b 100644 (file)
--- a/mgp.c
+++ b/mgp.c
@@ -631,7 +631,7 @@ static void
 mgp_usage(char *name)
 {
        fprintf(stderr, "Usage: %s [-BCeGhnOoPqRSUVv] [-b bgcolour] [-D htmldir] [-d [interval]]"
-           "\n    [-E htmlimage] [-F mode,effect,value] [-g geometry] [-p page]"
+           "\n    [-E htmlimage] [-F mode[,effect[,value]]] [-g geometry] [-p page]"
            "\n    [-Q quality] [-T timestampfile] [-t timeslot] [-X gsdevice]"
            "\n    [-x engine] file", name);
 
@@ -641,7 +641,7 @@ mgp_usage(char *name)
        fprintf(stderr, "\t-D <dir>: Generate html pages for the presentation\n");
        fprintf(stderr, "\t-d: Demo mode - go through the presentation\n");
        fprintf(stderr, "\t-E <name>: Use this image format in html (jpg or png)\n");
-       fprintf(stderr, "\t-F<mode>,<effect>,<value>: Use forwarding caches\n");
+       fprintf(stderr, "\t-F <mode>[,<effect>[,<value>]]: Use forwarding caches\n");
        fprintf(stderr, "\t-G: Page guide is on\n");
        fprintf(stderr, "\t-g <geometry>: Set window geometry\n");
        fprintf(stderr, "\t-h: Display this help message\n");