fix help in CLI brother_ql & list labels in README
This commit is contained in:
29
LEGACY.md
29
LEGACY.md
@@ -56,35 +56,6 @@ giving:
|
|||||||
--loglevel LOGLEVEL Set to DEBUG for verbose debugging output to stderr.
|
--loglevel LOGLEVEL Set to DEBUG for verbose debugging output to stderr.
|
||||||
|
|
||||||
The image argument should be a PNG/GIF/JPEG image file.
|
The image argument should be a PNG/GIF/JPEG image file.
|
||||||
Here is the output of `brother_ql_info list-label-sizes` listing the available options for `--label-size`:
|
|
||||||
|
|
||||||
Supported label sizes:
|
|
||||||
Name Printable px Description
|
|
||||||
12 106 (12 mm endless)
|
|
||||||
29 306 (29 mm endless)
|
|
||||||
38 413 (38 mm endless)
|
|
||||||
50 554 (50 mm endless)
|
|
||||||
54 590 (54 mm endless)
|
|
||||||
62 696 (62 mm endless)
|
|
||||||
102 1164 (102 mm endless)
|
|
||||||
17x54 165 x 566 (17 x 54 mm^2)
|
|
||||||
17x87 165 x 956 (17 x 87 mm^2)
|
|
||||||
23x23 202 x 202 (23 x 23 mm^2)
|
|
||||||
29x42 306 x 425 (29 x 42 mm^2)
|
|
||||||
29x90 306 x 991 (29 x 90 mm^2)
|
|
||||||
39x90 413 x 991 (38 x 90 mm^2)
|
|
||||||
39x48 425 x 495 (39 x 48 mm^2)
|
|
||||||
52x29 578 x 271 (52 x 29 mm^2)
|
|
||||||
62x29 696 x 271 (62 x 29 mm^2)
|
|
||||||
62x100 696 x 1109 (62 x 100 mm^2)
|
|
||||||
102x51 1164 x 526 (102 x 51 mm^2)
|
|
||||||
102x152 1164 x 1660 (102 x 152 mm^2)
|
|
||||||
d12 94 x 94 (12 mm diameter, round)
|
|
||||||
d24 236 x 236 (24 mm diameter, round)
|
|
||||||
d58 618 x 618 (58 mm diameter, round)
|
|
||||||
|
|
||||||
**Pro Tip™**:
|
|
||||||
For the best results, use image files with the matching pixel dimensions. Die-cut labels have to be in the exact pixel dimensions stated above. For endless label rolls, you can provide image files with a pixel width as stated above. If you provide a file with different dimensions when creating an endless label file, it will be scaled to fit the width.
|
|
||||||
|
|
||||||
### Print
|
### Print
|
||||||
|
|
||||||
|
|||||||
31
README.md
31
README.md
@@ -89,7 +89,7 @@ The most important command is the `print` command and here is its CLI signature:
|
|||||||
Options:
|
Options:
|
||||||
-l, --label [12|29|38|50|54|62|102|17x54|17x87|23x23|29x42|29x90|39x90|39x48|52x29|62x29|62x100|102x51|102x152|d12|d24|d58]
|
-l, --label [12|29|38|50|54|62|102|17x54|17x87|23x23|29x42|29x90|39x90|39x48|52x29|62x29|62x100|102x51|102x152|d12|d24|d58]
|
||||||
The label (size, type - die-cut or endless).
|
The label (size, type - die-cut or endless).
|
||||||
Run `brother_ql info list-labels` for a full
|
Run `brother_ql info labels` for a full
|
||||||
list including ideal pixel dimensions.
|
list including ideal pixel dimensions.
|
||||||
-r, --rotate [auto|0|90|180|270]
|
-r, --rotate [auto|0|90|180|270]
|
||||||
Rotate the image (counterclock-wise) by this
|
Rotate the image (counterclock-wise) by this
|
||||||
@@ -122,6 +122,35 @@ So, printing an image file onto 62mm endless tape on a QL-710W label printer can
|
|||||||
export BROTHER_QL_MODEL=QL-710W
|
export BROTHER_QL_MODEL=QL-710W
|
||||||
brother_ql print -l 62 my_image.png
|
brother_ql print -l 62 my_image.png
|
||||||
|
|
||||||
|
The available label names can be listed with `brother_ql info labels`:
|
||||||
|
|
||||||
|
Name Printable px Description
|
||||||
|
12 106 12mm endless
|
||||||
|
29 306 29mm endless
|
||||||
|
38 413 38mm endless
|
||||||
|
50 554 50mm endless
|
||||||
|
54 590 54mm endless
|
||||||
|
62 696 62mm endless
|
||||||
|
102 1164 102mm endless
|
||||||
|
17x54 165 x 566 17mm x 54mm die-cut
|
||||||
|
17x87 165 x 956 17mm x 87mm die-cut
|
||||||
|
23x23 202 x 202 23mm x 23mm die-cut
|
||||||
|
29x42 306 x 425 29mm x 42mm die-cut
|
||||||
|
29x90 306 x 991 29mm x 90mm die-cut
|
||||||
|
39x90 413 x 991 38mm x 90mm die-cut
|
||||||
|
39x48 425 x 495 39mm x 48mm die-cut
|
||||||
|
52x29 578 x 271 52mm x 29mm die-cut
|
||||||
|
62x29 696 x 271 62mm x 29mm die-cut
|
||||||
|
62x100 696 x 1109 62mm x 100mm die-cut
|
||||||
|
102x51 1164 x 526 102mm x 51mm die-cut
|
||||||
|
102x152 1164 x 1660 102mm x 153mm die-cut
|
||||||
|
d12 94 x 94 12mm round die-cut
|
||||||
|
d24 236 x 236 24mm round die-cut
|
||||||
|
d58 618 x 618 58mm round die-cut
|
||||||
|
|
||||||
|
**Pro Tip™**:
|
||||||
|
For the best results, use image files with the matching pixel dimensions. Die-cut labels have to be in the exact pixel dimensions stated above. For endless label rolls, you can provide image files with a pixel width as stated above. If you provide a file with different dimensions when creating an endless label file, it will be scaled to fit the width.
|
||||||
|
|
||||||
### Legacy command line tools
|
### Legacy command line tools
|
||||||
|
|
||||||
For a long time, this project provided multiple command line tools, such as `brother_ql_create`, `brother_ql_print`, `brother_ql_analyze`, and more.
|
For a long time, this project provided multiple command line tools, such as `brother_ql_create`, `brother_ql_print`, `brother_ql_analyze`, and more.
|
||||||
|
|||||||
@@ -76,7 +76,7 @@ def info(ctx, *args, **kwargs):
|
|||||||
|
|
||||||
@cli.command('print', short_help='Print a label')
|
@cli.command('print', short_help='Print a label')
|
||||||
@click.argument('images', nargs=-1, metavar='IMAGE [IMAGE] ...')
|
@click.argument('images', nargs=-1, metavar='IMAGE [IMAGE] ...')
|
||||||
@click.option('-l', '--label', type=click.Choice(label_sizes), envvar='BROTHER_QL_LABEL', help='The label (size, type - die-cut or endless). Run `brother_ql info list-labels` for a full list including ideal pixel dimensions.')
|
@click.option('-l', '--label', type=click.Choice(label_sizes), envvar='BROTHER_QL_LABEL', help='The label (size, type - die-cut or endless). Run `brother_ql info labels` for a full list including ideal pixel dimensions.')
|
||||||
@click.option('-r', '--rotate', type=click.Choice(('auto', '0', '90', '180', '270')), default='auto', help='Rotate the image (counterclock-wise) by this amount of degrees.')
|
@click.option('-r', '--rotate', type=click.Choice(('auto', '0', '90', '180', '270')), default='auto', help='Rotate the image (counterclock-wise) by this amount of degrees.')
|
||||||
@click.option('-t', '--threshold', type=float, default=70.0, help='The threshold value (in percent) to discriminate between black and white pixels.')
|
@click.option('-t', '--threshold', type=float, default=70.0, help='The threshold value (in percent) to discriminate between black and white pixels.')
|
||||||
@click.option('-d', '--dither', is_flag=True, help='Enable dithering when converting the image to b/w. If set, --threshold is meaningless.')
|
@click.option('-d', '--dither', is_flag=True, help='Enable dithering when converting the image to b/w. If set, --threshold is meaningless.')
|
||||||
|
|||||||
Reference in New Issue
Block a user