Commit 924c1291 by Lafont François

Update the man page

* Improve readability. * Add new upstream options. * Change the url home page in https.
parent ef870d87
.\" (C) Copyright 2014 Francois Lafont <francois.lafont@ac-versailles.fr>,
.\"
.\"
.\" Personal comments:
.\"
.\" * With "\fBxxx\fR" the text "xxx" is in bold.
.\" * With "\fBxxx\fR \fIyyy\fR" the text "xxx" is in bold
.\" and the text "yyy" is in italic.
.\" * In the previous example, the closing macro \fR is
.\" optional and "\fBxxx \fIyyy\fR" gives the same result.
.\"
.\"
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH XIA 1 "May 17, 2015"
.TH XIA 1 "December 11, 2016"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
......@@ -17,45 +28,67 @@
.\" .sp <n> insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
xia \- program to convert svg files to full html5 and interactive
xia - program to convert svg files to full html5 and interactive
pictures.
.SH SYNOPSIS
.B xia
[\fIinput-file\fR]
.B xia\fR [\fIinput-file\fR]
.br
.B xia
.B \-i
.I input-file
.B \-o
.I output-dir
.B \-t
.I theme
.B "xia -i" \fIinput-file \fB-o \fIoutput-dir\fR [\fB-t \fItheme\fR] [\fB-q \fIquality\fR] [\fB-e \fIexport-type\fR]
.br
.B xia -h
.br
.B xia -v
.SH DESCRIPTION
With the first call syntax, xia launches a graphical
interface. If present, the svg file
.I input-file
will be pre-selected. With the second call syntax,
xia runs in command line mode. In this case, you must
specify each option.
interface. If present, the svg file \fIinput-file\fR will be
pre-selected. With the second call syntax, xia runs in
command line mode.
.SH COMMAND LINE OPTIONS
.TP
.BI "\-i " input-file
The svg source file used to build the html5 interactive picture.
.BI "-i, --input " input-file
The svg source file used to build the html5 interactive
picture.
.TP
.BI "\-o " output-dir
The directory where the html5 files (and the javascript files) will
be copied after the run of xia.
.BI "-o, --output " output-dir
The directory where the html5 files (and the javascript
files) will be copied after the run of xia.
.TP
.BI "-t, --theme " theme
The theme which will be used to build the html5 interactive
picture. The available themes are listed in the online
documentation. The default value of this option is
\fBaccordionBlack\fR.
.TP
.BI "-q, --quality " quality
The image quality. The default value of this option is \fB3\fR.
.TP
.BI "\-t " theme
The theme which will be used to build the html5 interactive picture.
The available themes are listed in the online documentation.
.BI "-e, --export " export-type
The export type. Possible values are \fBsinglefile\fR,
\fBlti\fR and \fBlocal\fR. The default value of this option
is \fBsinglefile\fR.
.TP
.BI "-h, --help"
Display help text and exit.
.TP
.BI "-v, --version"
Display version and exit.
.SH SEE ALSO
The online documentation is here:
.br
http://xia.dane.ac-versailles.fr/index_en.html
https://xia.dane.ac-versailles.fr/index_en.html
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment