Add workaround for non-gui environments to glabels-batch manpage. (#68)

jimevins · Nov 28, 2019 · edcb0d7 · edcb0d7
1 parent f09ca36
commit edcb0d7
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 9 deletions.
diff --git a/user-docs/_build/man/glabels-batch-qt.1 b/user-docs/_build/man/glabels-batch-qt.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "GLABELS-BATCH-QT" "1" "May 05, 2019" "" "gLabels"
+.TH "GLABELS-BATCH-QT" "1" "Nov 27, 2019" "" "gLabels"
 .SH NAME
 glabels-batch-qt \- batch creation of labels and business cards
 .
@@ -56,7 +56,7 @@ Send output to <printer>.
 .UNINDENT
 .INDENT 0.0
 .TP
-.B \-o <filename>, \-\-output <filename>
+.B \-o [<filename>], \-\-output [<filename>]
 Set output filename to <filename>. Set to "\-" for stdout.
 (Default="output.pdf")
 .UNINDENT
@@ -90,6 +90,11 @@ Print crop marks.
 .B \-r, \-\-reverse
 Print in reverse (mirror image).
 .UNINDENT
+.INDENT 0.0
+.TP
+.B \-D <var>=<value>, \-\-define <var>=<value>
+Set initial value of user variable <var> to <value>.
+.UNINDENT
 .SH FILES
 .INDENT 0.0
 .TP
@@ -110,6 +115,19 @@ Directory for manually created product templates.
 .UNINDENT
 .SH BUGS
 .sp
+On GNU/Linux platforms, \fBglabels\-batch\-qt\fP must be run from within a windowing environment, such as X or Wayland.  This is because Qt requires a suitable platform to obtain system font information.  A work\-around is to run \fBglabels\-batch\-qt\fP using a virtual X server environment:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+xvfb\-run glabels\-batch\-qt \-o output.pdf myProject.glabels
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH REPORTING BUGS
+.sp
 Bugs and feature requests can be reported via the gLabels issue tracking system at GitHub (<\fI\%https://github.com/jimevins/glabels\-qt/issues\fP>).  You will need a GitHub account to submit new issues or to comment on existing issues.
 .SH SEE ALSO
 .sp

diff --git a/user-docs/_build/man/glabels-qt.1 b/user-docs/_build/man/glabels-qt.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH "GLABELS-QT" "1" "May 05, 2019" "" "gLabels"
+.TH "GLABELS-QT" "1" "Nov 27, 2019" "" "gLabels"
 .SH NAME
 glabels-qt \- create labels and business cards
 .
@@ -67,7 +67,7 @@ templates here!\fP
 .B ${HOME}/.glabels/
 Directory for manually created product templates.
 .UNINDENT
-.SH BUGS
+.SH REPORTING BUGS
 .sp
 Bugs and feature requests can be reported via the gLabels issue tracking system at GitHub (<\fI\%https://github.com/jimevins/glabels\-qt/issues\fP>).  You will need a GitHub account to submit new issues or to comment on existing issues.
 .SH SEE ALSO

diff --git a/user-docs/man/glabels-batch-qt.rst b/user-docs/man/glabels-batch-qt.rst
@@ -27,13 +27,11 @@ OPTIONS
 
              Displays version information and exits.
 
-.. program:: glabels-batch-qt
-
 .. option:: -p <printer>, --printer <printer>
 
 	    Send output to <printer>.
 
-.. option::  -o <filename>, --output <filename>
+.. option::  -o [<filename>], --output [<filename>]
 
 	     Set output filename to <filename>. Set to "-" for stdout.
 	     (Default="output.pdf")
@@ -62,6 +60,10 @@ OPTIONS
 
              Print in reverse (mirror image).
 
+.. option::  -D <var>=<value>, --define <var>=<value>
+
+	     Set initial value of user variable <var> to <value>.
+
 FILES
 -----
 
@@ -82,6 +84,16 @@ FILES
 BUGS
 ----
 
+On GNU/Linux platforms, :program:`glabels-batch-qt` must be run from within a windowing environment, such as X or Wayland.  This is because Qt requires a suitable platform to obtain system font information.  A work-around is to run :program:`glabels-batch-qt` using a virtual X server environment:
+
+.. code:: shell
+	  
+	  xvfb-run glabels-batch-qt -o output.pdf myProject.glabels
+
+	  
+REPORTING BUGS
+--------------
+
 Bugs and feature requests can be reported via the gLabels issue tracking system at GitHub (<https://github.com/jimevins/glabels-qt/issues>).  You will need a GitHub account to submit new issues or to comment on existing issues.
 
 SEE ALSO

diff --git a/user-docs/man/glabels-qt.rst b/user-docs/man/glabels-qt.rst
@@ -43,8 +43,8 @@ FILES
 
               Directory for manually created product templates.
 
-BUGS
-----
+REPORTING BUGS
+--------------
 
 Bugs and feature requests can be reported via the gLabels issue tracking system at GitHub (<https://github.com/jimevins/glabels-qt/issues>).  You will need a GitHub account to submit new issues or to comment on existing issues.
-Original file line number
+Diff line change
@@ Expand Up / @@ -43,8 +43,8 @@ FILES @@
                   Directory for manually created product templates.
-    BUGS
-    ----
+    REPORTING BUGS
+    --------------
     Bugs and feature requests can be reported via the gLabels issue tracking system at GitHub (<https://github.com/jimevins/glabels-qt/issues>).  You will need a GitHub account to submit new issues or to comment on existing issues.
@@ Expand Down @@