File: help.md

package info (click to toggle)
lablie 0.6.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 3,256 kB
  • sloc: java: 2,637; sh: 71; makefile: 19
file content (67 lines) | stat: -rw-r--r-- 2,717 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# `lablie` help

```
Usage: lablie [-hv] [COMMAND]
Tool to generate documents with labels for printing.
  -h, --help      display a help message
  -v, --version   display version info
Commands:
  tile      Tile labels
  instance  Fill label template with instance data
  project   Group command for project manipulation sub-commands
```

Command `tile`:
```
Usage: lablie tile [OPTIONS] SOURCE TARGET
Tile labels
      SOURCE                 Path to SVG file containing a label
      TARGET                 Path to SVG file which should be generated
      --dataset-csv FILE     Path to CSV file containing instances
      --dataset-csv-format FORMAT
                             Sets format for parsing CSV dataset (available options:
                               Default, Excel, InformixUnload, InformixUnloadCsv,
                               MySQL, PostgreSQLCsv, PostgreSQLText, RFC4180, TDF)
      --dataset-json FOLDER  Path to folder containing JSON files for instances
      --instance KEY         Key of instance to be rendered
      --instance-json FILE   Path to JSON file containing values for single instance
      --instances-json FILE  Path to JSON file containing array of instances (can be
                               used in combination with --dataset-json)
      --label-delta mm mm    X and Y delta between labels in mm, ie. 5 5
      --label-offset mm mm   X and Y offset of the first label in mm, ie. 5 5
      --label-size mm mm     Width and height of label in mm, ie.
      --paper-size mm mm     Width and height of the paper in mm, ie. 210 297 for A4
                               paper portrait
      --template-descriptor FILE
                             Path to JSON file containing descriptor of template
  -h, --help                 display a help message
```

Command `instance`:
```
Usage: lablie instance [OPTIONS] SOURCE TARGET
Fill label template with instance data
      SOURCE   Path of a SVG file containing a label
      TARGET   Path of a SVG file which should be generated
      --instance-json <instanceJsonFile>
               Path to JSON file containing values for single instance
  -h, --help   display a help message
```

Command `project`:
```
Usage: lablie project [OPTIONS] [PROJECT_FILE] [COMMAND]
Group command for project manipulation sub-commands
      [PROJECT_FILE]   File containing project configuration
  -h, --help           display a help message
Commands:
  generate-makefile  Generates makefile for project
```

Command `project generate-makefile`:
```
Usage: lablie project generate-makefile [OPTIONS]
Generates makefile for project
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.
```