Update man.

--HG--
branch : feature
This commit is contained in:
Roman Telezhynskyi 2019-03-30 11:48:20 +02:00
parent 69df0922af
commit 3b2b51fa74
5 changed files with 16 additions and 17 deletions

View File

@ -1,6 +1,6 @@
.\" Manpage for valentina. .\" Manpage for valentina.
.\" Contact dismine@gmail.com to correct errors. .\" Contact dismine@gmail.com to correct errors.
.TH valentina 1 "27 December, 2018" "valentina man page" .TH valentina 1 "30 March, 2019" "valentina man page"
.SH NAME .SH NAME
Valentina \- Pattern making program. Valentina \- Pattern making program.
.SH SYNOPSIS .SH SYNOPSIS
@ -23,6 +23,10 @@ Displays version information.
The path to output destination folder. By default the directory at which the application was started. The path must exists and be reachable for the program. The path to output destination folder. By default the directory at which the application was started. The path must exists and be reachable for the program.
.IP "-m, --mfile <The measure file>" .IP "-m, --mfile <The measure file>"
.RB "Path to custom measure file (" "export mode" ")." .RB "Path to custom measure file (" "export mode" ")."
.IP "-n, --time <Time>"
.RB "<Time> in minutes given for the algorithm to find best layout (" "export mode" "). Time must be in range from 1 minute to 60 minutes. Default value 1 minute."
.IP "--сoefficient <Coefficient>"
.RB "Set layout efficiency coefficient (" "export mode" "). Layout efficiency coefficient is the ratio of the area occupied by the pieces to the bounding rect of all pieces. If nesting reaches required level the process stops. If value is 0 no check will be made. Сoefficient must be in range from 0 to 100. Default value 0."
.IP "-f, --format <Format number>" .IP "-f, --format <Format number>"
.RB "Number corresponding to output format (default = 0, " "export mode" "):" .RB "Number corresponding to output format (default = 0, " "export mode" "):"
.RS .RS
@ -182,8 +186,6 @@ The path to output destination folder. By default the directory at which the app
.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." .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."
.IP "-B, --bmargin <The bottom margin>" .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." .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."
.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 "--followGrainline" .IP "--followGrainline"
.RB "Order detail to follow grainline direction (" "export mode" "). .RB "Order detail to follow grainline direction (" "export mode" ").
.IP "-c, --crop" .IP "-c, --crop"
@ -194,8 +196,6 @@ The path to output destination folder. By default the directory at which the app
.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." .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>" .IP "-l, --layounits <The unit>"
.RB "Layout units (as paper's one except px, " "export mode" ")." .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>" .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." .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>" .IP "-g, --groups <Grouping type>"

View File

@ -1,6 +1,6 @@
.\" Manpage for valentina. .\" Manpage for valentina.
.\" Contact dismine@gmail.com to correct errors. .\" Contact dismine@gmail.com to correct errors.
.TH valentina 1 "27 December, 2018" "valentina man page" .TH valentina 1 "30 March, 2019" "valentina man page"
.SH NAME .SH NAME
Valentina \- Pattern making program. Valentina \- Pattern making program.
.SH SYNOPSIS .SH SYNOPSIS
@ -23,6 +23,10 @@ Displays version information.
The path to output destination folder. By default the directory at which the application was started. The path must exists and be reachable for the program. The path to output destination folder. By default the directory at which the application was started. The path must exists and be reachable for the program.
.IP "-m, --mfile <The measure file>" .IP "-m, --mfile <The measure file>"
.RB "Path to custom measure file (" "export mode" ")." .RB "Path to custom measure file (" "export mode" ")."
.IP "-n, --time <Time>"
.RB "<Time> in minutes given for the algorithm to find best layout (" "export mode" "). Time must be in range from 1 minute to 60 minutes. Default value 1 minute."
.IP "--сoefficient <Coefficient>"
.RB "Set layout efficiency coefficient (" "export mode" "). Layout efficiency coefficient is the ratio of the area occupied by the pieces to the bounding rect of all pieces. If nesting reaches required level the process stops. If value is 0 no check will be made. Сoefficient must be in range from 0 to 100. Default value 0."
.IP "-f, --format <Format number>" .IP "-f, --format <Format number>"
.RB "Number corresponding to output format (default = 0, " "export mode" "):" .RB "Number corresponding to output format (default = 0, " "export mode" "):"
.RS .RS
@ -182,8 +186,6 @@ The path to output destination folder. By default the directory at which the app
.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." .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."
.IP "-B, --bmargin <The bottom margin>" .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." .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."
.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 "--followGrainline" .IP "--followGrainline"
.RB "Order detail to follow grainline direction (" "export mode" "). .RB "Order detail to follow grainline direction (" "export mode" ").
.IP "-c, --crop" .IP "-c, --crop"
@ -194,8 +196,6 @@ The path to output destination folder. By default the directory at which the app
.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." .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>" .IP "-l, --layounits <The unit>"
.RB "Layout units (as paper's one except px, " "export mode" ")." .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>" .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." .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>" .IP "-g, --groups <Grouping type>"

View File

@ -596,13 +596,14 @@ void VCommandLine::InitCommandLineOptions()
optionsUsed.insert(LONG_OPTION_NESTING_TIME, option); optionsUsed.insert(LONG_OPTION_NESTING_TIME, option);
parser.addOption(option); parser.addOption(option);
option = VCommandLineOption(QStringList({SINGLE_OPTION_EFFICIENCY_COEFFICIENT, LONG_OPTION_EFFICIENCY_COEFFICIENT}), option = VCommandLineOption(LONG_OPTION_EFFICIENCY_COEFFICIENT,
translate("VCommandLine", "Set layout efficiency coefficient. Layout efficiency " translate("VCommandLine", "Set layout efficiency <coefficient>. Layout efficiency "
"coefficient is the ratio of the area occupied by the pieces " "coefficient is the ratio of the area occupied by the pieces "
"to the entire area of the sheet. If nesting reaches " "to the bounding rect of all pieces. If nesting reaches "
"required level the process stops. If value is 0 no check " "required level the process stops. If value is 0 no check "
"will be made. Сoefficient must be in range from 0 to 100. " "will be made. Сoefficient must be in range from 0 to 100. "
"Default value 0.")); "Default value 0."),
translate("VCommandLine", "Coefficient"));
optionsUsed.insert(LONG_OPTION_EFFICIENCY_COEFFICIENT, option); optionsUsed.insert(LONG_OPTION_EFFICIENCY_COEFFICIENT, option);
parser.addOption(option); parser.addOption(option);

View File

@ -113,7 +113,6 @@ const QString LONG_OPTION_NESTING_TIME = QStringLiteral("time");
const QString SINGLE_OPTION_NESTING_TIME = QStringLiteral("n"); const QString SINGLE_OPTION_NESTING_TIME = QStringLiteral("n");
const QString LONG_OPTION_EFFICIENCY_COEFFICIENT = QStringLiteral("сoefficient"); const QString LONG_OPTION_EFFICIENCY_COEFFICIENT = QStringLiteral("сoefficient");
const QString SINGLE_OPTION_EFFICIENCY_COEFFICIENT= QStringLiteral("e");
const QString LONG_OPTION_CSVWITHHEADER = QStringLiteral("csvWithHeader"); const QString LONG_OPTION_CSVWITHHEADER = QStringLiteral("csvWithHeader");
const QString LONG_OPTION_CSVCODEC = QStringLiteral("csvCodec"); const QString LONG_OPTION_CSVCODEC = QStringLiteral("csvCodec");
@ -169,7 +168,7 @@ QStringList AllKeys()
LONG_OPTION_TOP_MARGIN, SINGLE_OPTION_TOP_MARGIN, LONG_OPTION_TOP_MARGIN, SINGLE_OPTION_TOP_MARGIN,
LONG_OPTION_BOTTOM_MARGIN, SINGLE_OPTION_BOTTOM_MARGIN, LONG_OPTION_BOTTOM_MARGIN, SINGLE_OPTION_BOTTOM_MARGIN,
LONG_OPTION_NESTING_TIME, SINGLE_OPTION_NESTING_TIME, LONG_OPTION_NESTING_TIME, SINGLE_OPTION_NESTING_TIME,
LONG_OPTION_EFFICIENCY_COEFFICIENT, SINGLE_OPTION_EFFICIENCY_COEFFICIENT, LONG_OPTION_EFFICIENCY_COEFFICIENT,
LONG_OPTION_NO_HDPI_SCALING, LONG_OPTION_NO_HDPI_SCALING,
LONG_OPTION_CSVWITHHEADER, LONG_OPTION_CSVWITHHEADER,
LONG_OPTION_CSVCODEC, LONG_OPTION_CSVCODEC,

View File

@ -110,7 +110,6 @@ extern const QString LONG_OPTION_NESTING_TIME;
extern const QString SINGLE_OPTION_NESTING_TIME; extern const QString SINGLE_OPTION_NESTING_TIME;
extern const QString LONG_OPTION_EFFICIENCY_COEFFICIENT; extern const QString LONG_OPTION_EFFICIENCY_COEFFICIENT;
extern const QString SINGLE_OPTION_EFFICIENCY_COEFFICIENT;
extern const QString LONG_OPTION_CSVWITHHEADER; extern const QString LONG_OPTION_CSVWITHHEADER;
extern const QString LONG_OPTION_CSVCODEC; extern const QString LONG_OPTION_CSVCODEC;