Commit | Line | Data |
---|---|---|
0659f3af PP |
1 | [[params-fmt]] |
2 | Parameters format | |
3 | ~~~~~~~~~~~~~~~~~ | |
4 | The format of the 'PARAMS' option's argument is a comma-separated | |
5 | list of `NAME=VALUE` assignments: | |
6 | ||
7 | [verse] | |
8 | 'NAME'='VALUE'[,'NAME'='VALUE']... | |
9 | ||
10 | 'NAME':: | |
11 | Parameter name (C{nbsp}identifier plus the `:`, `.`, and `-` characters). | |
12 | ||
13 | 'VALUE':: | |
14 | One of: | |
15 | + | |
16 | -- | |
17 | * `null`, `nul`, `NULL`: null value. | |
18 | ||
19 | * `true`, `TRUE`, `yes`, `YES`: true boolean value. | |
20 | ||
21 | * `false`, `FALSE`, `no`, `NO`: false boolean value. | |
22 | ||
23 | * Binary (`0b` prefix), octal (`0` prefix), decimal, or hexadecimal | |
24 | (`0x` prefix) signed 64-bit integer. | |
25 | ||
26 | * Double precision floating point number (scientific notation is | |
27 | accepted). | |
28 | ||
29 | * Unquoted string with no special characters, and not matching any of | |
30 | the null and boolean value symbols above. | |
31 | ||
32 | * Double-quoted string (accepts escape characters). | |
33 | ||
b25da386 SM |
34 | * Array, formatted as an opening `[`, a list of comma-separated values |
35 | (as described by the current list) and a closing `]`. | |
36 | ||
0659f3af PP |
37 | You may put whitespaces around the individual `=` (assignment) and `,` |
38 | (separator) characters. | |
39 | -- | |
40 | ||
41 | Example: | |
42 | ||
43 | ---- | |
44 | babeltrace ... --params='many=null, fresh=yes, condition=false, | |
45 | squirrel=-782329, observe=3.14, | |
46 | simple=beef, needs-quotes="some string", | |
b25da386 SM |
47 | escape.chars-are:allowed="a \" quote", |
48 | things=[1, "2", 3]' | |
0659f3af PP |
49 | ---- |
50 | ||
51 | IMPORTANT: Like in the example above, make sure to single-quote the | |
52 | whole argument when you run this command from a shell. |