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

This commit is contained in:
Jim Evins
2019-11-27 19:26:00 -05:00
parent f09ca36b7b
commit edcb0d7166
4 changed files with 39 additions and 9 deletions
+20 -2
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" 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 .SH NAME
glabels-batch-qt \- batch creation of labels and business cards glabels-batch-qt \- batch creation of labels and business cards
. .
@@ -56,7 +56,7 @@ Send output to <printer>.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-o <filename>, \-\-output <filename> .B \-o [<filename>], \-\-output [<filename>]
Set output filename to <filename>. Set to "\-" for stdout. Set output filename to <filename>. Set to "\-" for stdout.
(Default="output.pdf") (Default="output.pdf")
.UNINDENT .UNINDENT
@@ -90,6 +90,11 @@ Print crop marks.
.B \-r, \-\-reverse .B \-r, \-\-reverse
Print in reverse (mirror image). Print in reverse (mirror image).
.UNINDENT .UNINDENT
.INDENT 0.0
.TP
.B \-D <var>=<value>, \-\-define <var>=<value>
Set initial value of user variable <var> to <value>.
.UNINDENT
.SH FILES .SH FILES
.INDENT 0.0 .INDENT 0.0
.TP .TP
@@ -110,6 +115,19 @@ Directory for manually created product templates.
.UNINDENT .UNINDENT
.SH BUGS .SH BUGS
.sp .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. 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 .SH SEE ALSO
.sp .sp
+2 -2
View File
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText. .\" Man page generated from reStructuredText.
. .
.TH "GLABELS-QT" "1" "May 05, 2019" "" "gLabels" .TH "GLABELS-QT" "1" "Nov 27, 2019" "" "gLabels"
.SH NAME .SH NAME
glabels-qt \- create labels and business cards glabels-qt \- create labels and business cards
. .
@@ -67,7 +67,7 @@ templates here!\fP
.B ${HOME}/.glabels/ .B ${HOME}/.glabels/
Directory for manually created product templates. Directory for manually created product templates.
.UNINDENT .UNINDENT
.SH BUGS .SH REPORTING BUGS
.sp .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. 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 .SH SEE ALSO
+15 -3
View File
@@ -27,13 +27,11 @@ OPTIONS
Displays version information and exits. Displays version information and exits.
.. program:: glabels-batch-qt
.. option:: -p <printer>, --printer <printer> .. option:: -p <printer>, --printer <printer>
Send output to <printer>. Send output to <printer>.
.. option:: -o <filename>, --output <filename> .. option:: -o [<filename>], --output [<filename>]
Set output filename to <filename>. Set to "-" for stdout. Set output filename to <filename>. Set to "-" for stdout.
(Default="output.pdf") (Default="output.pdf")
@@ -62,6 +60,10 @@ OPTIONS
Print in reverse (mirror image). Print in reverse (mirror image).
.. option:: -D <var>=<value>, --define <var>=<value>
Set initial value of user variable <var> to <value>.
FILES FILES
----- -----
@@ -82,6 +84,16 @@ FILES
BUGS 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. 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 SEE ALSO
+2 -2
View File
@@ -43,8 +43,8 @@ FILES
Directory for manually created product templates. 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. 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.