Improved Valentina's man file.

--HG--
branch : develop
This commit is contained in:
Roman Telezhynskyi 2015-11-21 15:37:05 +02:00
parent 9e4ead188a
commit 31622f9fa6

View file

@ -1,86 +1,144 @@
.\" Manpage for valentina. .\" Manpage for valentina.
.\" Contact dismine@gmail.com.in to correct errors. .\" Contact dismine@gmail.com to correct errors.
.TH man 1 "8 September 2015" "valentina man page" .TH valentina 1 "21 October, 2015" "valentina man page"
.SH NAME .SH NAME
valentina \- Pattern making program. valentina \- Pattern making program.
.SH SYNOPSIS .SH SYNOPSIS
valentina [options] file valentina [options] file
.SH DESCRIPTION .SH DESCRIPTION
Valentina is a cross-platform patternmaking program which allows designers .B Valentina
is a cross-platform patternmaking program which allows designers
to create and model patterns of clothing. This software allows pattern to create and model patterns of clothing. This software allows pattern
creation, using either standard sizing tables or an individuals set of creation, using either standard sizing tables or an individuals set of
measurements. It blends new technologies with traditional methods to create measurements. It blends new technologies with traditional methods to create
a unique pattern making tool. a unique pattern making tool.
.SH OPTIONS .SH OPTIONS
-h, --help Displays this help. .IP "-h, --help"
-v, --version Displays version information. Displays this help.
-o, --outfile <The exported layout file> Path to output exported layout .IP "-v, --version"
file. Use it to enable console Displays version information.
export mode. .IP "-b, --basename <The base filename of layout files>"
-m, --mfile <The measure file> Path to custom measure file (export .RB "The base filename of exported layout files. Use it to enable console " "export mode" "."
mode). .IP "-d, --destination <The destination folder>"
-f, --format <Format number> Number corresponding to output The path to output destination folder. By default the directory at which the application was started.
format (default = 0, export mode): .IP "-m, --mfile <The measure file>"
Svg files (*.svg) = 0 .RB "Path to custom measure file (" "export mode" ")."
PDF files (*.pdf) = 1 .IP "-f, --format <Format number>"
Images (*.png) = 2 .RB "Number corresponding to output format (default = 0, " "export mode" "):"
Wavefront OBJ (*.obj) = 3 .RS
PS files (*.ps) = 4 .BR "*" " Svg files (*.svg) = 0,"
EPS files (*.eps) = 5 .RE
DXF files (*.dxf) = 6 .RS
.BR "*" " PDF files (*.pdf) = 1,"
-p, --pageformat <Template number> Number corresponding to page .RE
template (default = 0, export mode): .RS
A0 = 0 .BR "*" " Images (*.png) = 2,"
A1 = 1 .RE
A2 = 2 .RS
A3 = 3 .BR "*" " Wavefront OBJ (*.obj) = 3,"
A4 = 4 .RE
Letter = 5 .RS
Legal = 6 .BR "*" " PS files (*.ps) = 4,"
Roll 24in = 7 .RE
Roll 30in = 8 .RS
Roll 36in = 9 .BR "*" " EPS files (*.eps) = 5,"
Roll 42in = 10 .RE
Roll 44in = 11 .RS
.BR "*" " DXF files (*.dxf) = 6."
-W, --pagew <The page width> Page width in current units like .RE
12.0 (cannot be used with .IP "-x, --gsize <The size value>"
"pageformat", export mode). .RB "Set size value a pattern file, that was opened with standard measurements " "(export mode)" ". Valid values: 22, 24, 26, 28, 30, 32, 34, 36, 38, 40, 42, 44, 46, 48, 50, 52, 54, 56cm."
-H, --pageh <The page height> Page height in current units like .IP "-e, --gheight <The height value>"
12.0 (cannot be used with .RB "Set height value a pattern file, that was opened with standard measurements (" "export mode" "). Valid values: 92, 98, 104, 110, 116, 122, 128, 134, 140, 146, 152, 158, 164, 170, 176, 182, 188, 194cm."
"pageformat", export mode). .IP "-p, --pageformat <Template number>"
-U, --pageunits <The measure unit> Page height/width measure units .RB "Number corresponding to page template (default = 0, " "export mode" "):"
(cannot be used with "pageformat", .RS
export mode): mm, cm, inch, px .BR "*" " A0 = 0,"
-r, --rotate <Angle> Rotation in degrees (one of .RE
predefined). Default (or 0) is .RS
no-rotate (export mode). .BR "*" " A1 = 1,"
-c, --crop Auto crop unused length (export .RE
mode). .RS
-u, --unite Unite pages if possible (export .BR "*" " A2 = 2,"
mode). .RE
-S, --savelen Save length of the sheet if set. .RS
(export mode). .BR "*" " A3 = 3,"
-l, --layounits <The unit> Layout units (as paper's one except .RE
px, export mode). .RS
-s, --shiftlen <Shift length> Shift layout length measured in .BR "*" " A4 = 4,"
layout units (export mode). .RE
-G, --gapwidth <The gap width> Gap width x2, measured in layout .RS
units. (export mode). .BR "*" " Letter = 5,"
-g, --groups <Grouping type> Sets layout groupping (export .RE
mode): .RS
Three groups: big, middle, small = 0 .BR "*" " Legal = 6,"
Two groups: big, small = 1 .RE
Descending area = 2 .RS
-L, --locale <Locale> Sets language locale (export mode). .BR "*" " Roll 24in = 7,"
Default is system locale. Supported .RE
locales: ru_RU, uk_UA, de_DE, cs_CZ, .RS
he_IL, fr_FR, it_IT, nl_NL, id_ID, .BR "*" " Roll 30in = 8,"
es_ES, fi_FI, en_US .RE
.RS
.BR "*" " Roll 36in = 9,"
Arguments: .RE
filename Pattern file. .RS
.BR "*" " Roll 42in = 10,"
.RE
.RS
.BR "*" " Roll 44in = 11."
.RE
.IP "-W, --pagew <The page width>"
.RB "Page width in current units like 12.0 (cannot be used with \*(lqpageformat\*(rq, " "export mode" ")."
.IP "-H, --pageh <The page height>"
.RB "Page height in current units like 12.0 (cannot be used with \*(lqpageformat\*(rq, " "export mode" ")."
.IP "-U, --pageunits <The measure unit>"
.RB "Page height/width measure units (cannot be used with \*(lqpageformat\*(rq, " "export mode" "). Valid values: mm, cm, inch, px."
.IP "-i, --ignoremargins"
.RB "Ignore margins printing (" "export mode" "). Disable value keys: \*(lqlmargin", \*(lqrmargin\*(rq, \*(lqtmargin\*(rq, \*(lqbmargin\*(rq. Set all margins to 0."
.IP "-L, --lmargin <The left margin>"
.RB "Page left margin in current units like 3.0 (" "export mode" "). If not set will be used value from default printer. Or 0 if none printers was found. Value will be ignored if key \*(lqignoremargins\*(rq is used."
.IP "-R, --rmargin <The right margin>"
.RB "Page right margin in current units like 3.0 (" "export mode" "). If not set will be used value from default printer. Or 0 if none printers was found. Value will be ignored if key \*(lqignoremargins\*(rq is used."
.IP "-T, --tmargin <The top margin>"
.RB "Page top margin in current units like 3.0 (" "export mode" "). If not set will be used value from default printer. Or 0 if none printers was found. Value will be ignored if key \*(lqignoremargins\*(rq is used."
.IP "-B, --bmargin <The bottom margin>"
.RB "Page bottom margin in current units like 3.0 (" "export mode" "). If not set will be used value from default printer. Or 0 if none printers was found. Value will be ignored if key \*(lqignoremargins\*(rq is used."
.IP "-r, --rotate <Angle>"
.RB "Rotation in degrees (one of predefined, " "export mode" "). Default value is " "180" ". 0 is no-rotate. Valid values: 0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 12, 15, 18, 20, 24, 30, 36, 40, 45, 60, 72, 90, 180. Each value show how many times details will be rotated. For example 180 mean two times (360/180=2) by 180 degree."
.IP "-c, --crop"
.RB "Auto crop unused length (" "export mode" ")."
.IP "-u, --unite"
.RB "Unite pages if possible (" "export mode" "). Maximum value limited by QImage that supports only a maximum of " "32768x32768 px" " images."
.IP "-S, --savelen"
.RB "Save length of the sheet if set (" "export mode" "). The option tells the program to use as much as possible width of sheet. Quality of a layout can be worse when this option was used."
.IP "-l, --layounits <The unit>"
.RB "Layout units (as paper's one except px, " "export mode" ")."
.IP "-s, --shiftlen <Shift length>"
.RB "Shift layout length measured in layout units (" "export mode" "). The option show how many points along edge will be used in creating a layout."
.IP "-G, --gapwidth <The gap width>"
.RB "The layout gap width x2, measured in layout units (" "export mode" "). Set distance between details and a detail and a sheet."
.IP "-g, --groups <Grouping type>"
.RB "Sets layout groupping cases (" "export mode" "):"
.RS
.BR "*" " Three groups: big, middle, small = 0,"
.RE
.RS
.BR "*" " Two groups: big, small = 1,"
.RE
.RS
.BR "*" " Descending area = 2."
.RE
.IP "-t, --test"
Run the program in a test mode. The program in this mode loads a single pattern file and silently quit without showing the main window. The key have priority before key \*(lqbasename\*(rq.
.IP Arguments:
.I filename
\- a pattern file.
.SH AUTHOR .SH AUTHOR
This manual page was written by Roman Telezhynskyi <dismine@gmail.com> .RI "This manual page was written by Roman Telezhynskyi <" dismine@gmail.com ">"
.SH "SEE ALSO"
.RB "Full " "User Manual" " is availiable in"
.UR https://bitbucket.org/dismine/valentina/wiki/manual/Content
.UE
.BR tape (1)