$ mlr --help-all-keywords
-filter: includes/excludes the record in the output record stream.
+dump: prints all currently defined out-of-stream variables immediately
+ to stdout as JSON.
- Example: mlr --from f.dat put 'filter (NR == 2 || $x > 5.4)'
-
- Instead of put with 'filter false' you can simply use put -q. The following
- uses the input record to accumulate data but only prints the running sum
- without printing the input record:
-
- Example: mlr --from f.dat put -q '@running_sum += $x * $y; emit @running_sum'
-
-unset: clears field(s) from the current record, or an out-of-stream variable.
-
- Example: mlr --from f.dat put 'unset $x'
- Example: mlr --from f.dat put 'unset $*'
- Example: mlr --from f.dat put 'for (k, v in $*) { if (k =~ "a.*") { unset $[k] } }'
- Example: mlr --from f.dat put '...; unset @sums'
- Example: mlr --from f.dat put '...; unset @sums["green"]'
- Example: mlr --from f.dat put '...; unset @*'
-
-tee: prints the current record to specified file.
- This is an immediate print to the specified file (except for pprint format
- which of course waits until the end of the input stream to format all output).
+ With >, >>, or |, the data do not become part of the output record stream but
+ are instead redirected.
The > and >> are for write and append, as in the shell, but (as with awk) the
file-overwrite for > is on first write, not per record. The | is for piping to
@@ -4609,16 +4592,15 @@ tee: prints the current record to specified file.
value of the piped-to command (for |). Output-formatting flags are taken from
the main command line.
- You can use any of the output-format command-line flags, e.g. --ocsv, --ofs,
- etc., to control the format of the output. See also mlr -h.
+ Example: mlr --from f.dat put -q '@v[NR]=$*; end { dump }'
+ Example: mlr --from f.dat put -q '@v[NR]=$*; end { dump > "mytap.dat"}'
+ Example: mlr --from f.dat put -q '@v[NR]=$*; end { dump >> "mytap.dat"}'
+ Example: mlr --from f.dat put -q '@v[NR]=$*; end { dump | "jq .[]"}'
- Example: mlr --from f.dat put 'tee > "/tmp/data-".$a, $*'
- Example: mlr --from f.dat put 'tee >> "/tmp/data-".$a.$b, $*'
- Example: mlr --from f.dat put 'tee > stderr, $*'
- Example: mlr --from f.dat put -q 'tee | "tr [a-z\] [A-Z\]", $*'
- Example: mlr --from f.dat put -q 'tee | "tr [a-z\] [A-Z\] > /tmp/data-".$a, $*'
- Example: mlr --from f.dat put -q 'tee | "gzip > /tmp/data-".$a.".gz", $*'
- Example: mlr --from f.dat put -q --ojson 'tee | "gzip > /tmp/data-".$a.".gz", $*'
+edump: prints all currently defined out-of-stream variables immediately
+ to stderr as JSON.
+
+ Example: mlr --from f.dat put -q '@v[NR]=$*; end { edump }'
emit: inserts an out-of-stream variable into the output record stream. Hashmap
indices present in the data but not slotted by emit arguments are not output.
@@ -4648,6 +4630,33 @@ emit: inserts an out-of-stream variable into the output record stream. Hashmap
Please see http://johnkerl.org/miller/doc for more information.
+emitf: inserts non-indexed out-of-stream variable(s) side-by-side into the
+ output record stream.
+
+ With >, >>, or |, the data do not become part of the output record stream but
+ are instead redirected.
+
+ The > and >> are for write and append, as in the shell, but (as with awk) the
+ file-overwrite for > is on first write, not per record. The | is for piping to
+ a process which will process the data. There will be one open file for each
+ distinct file name (for > and >>) or one subordinate process for each distinct
+ value of the piped-to command (for |). Output-formatting flags are taken from
+ the main command line.
+
+ You can use any of the output-format command-line flags, e.g. --ocsv, --ofs,
+ etc., to control the format of the output if the output is redirected. See also mlr -h.
+
+ Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf @a'
+ Example: mlr --from f.dat put --oxtab '@a=$i;@b+=$x;@c+=$y; emitf > "tap-".$i.".dat", @a'
+ Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf @a, @b, @c'
+ Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf > "mytap.dat", @a, @b, @c'
+ Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf >> "mytap.dat", @a, @b, @c'
+ Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf > stderr, @a, @b, @c'
+ Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf | "grep somepattern", @a, @b, @c'
+ Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf | "grep somepattern > mytap.dat", @a, @b, @c'
+
+ Please see http://johnkerl.org/miller/doc for more information.
+
emitp: inserts an out-of-stream variable into the output record stream.
Hashmap indices present in the data but not slotted by emitp arguments are
output concatenated with ":".
@@ -4677,55 +4686,23 @@ emitp: inserts an out-of-stream variable into the output record stream.
Please see http://johnkerl.org/miller/doc for more information.
-emitf: inserts non-indexed out-of-stream variable(s) side-by-side into the
- output record stream.
+eprint: prints expression immediately to stderr.
+ Example: mlr --from f.dat put -q 'eprint "The sum of x and y is ".($x+$y)'
+ Example: mlr --from f.dat put -q 'for (k, v in $*) { eprint k . " => " . v }'
+ Example: mlr --from f.dat put '(NR % 1000 == 0) { eprint "Checkpoint ".NR}'
- With >, >>, or |, the data do not become part of the output record stream but
- are instead redirected.
+eprintn: prints expression immediately to stderr, without trailing newline.
+ Example: mlr --from f.dat put -q 'eprintn "The sum of x and y is ".($x+$y); eprint ""'
- The > and >> are for write and append, as in the shell, but (as with awk) the
- file-overwrite for > is on first write, not per record. The | is for piping to
- a process which will process the data. There will be one open file for each
- distinct file name (for > and >>) or one subordinate process for each distinct
- value of the piped-to command (for |). Output-formatting flags are taken from
- the main command line.
+filter: includes/excludes the record in the output record stream.
- You can use any of the output-format command-line flags, e.g. --ocsv, --ofs,
- etc., to control the format of the output if the output is redirected. See also mlr -h.
+ Example: mlr --from f.dat put 'filter (NR == 2 || $x > 5.4)'
- Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf @a'
- Example: mlr --from f.dat put --oxtab '@a=$i;@b+=$x;@c+=$y; emitf > "tap-".$i.".dat", @a'
- Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf @a, @b, @c'
- Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf > "mytap.dat", @a, @b, @c'
- Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf >> "mytap.dat", @a, @b, @c'
- Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf > stderr, @a, @b, @c'
- Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf | "grep somepattern", @a, @b, @c'
- Example: mlr --from f.dat put '@a=$i;@b+=$x;@c+=$y; emitf | "grep somepattern > mytap.dat", @a, @b, @c'
+ Instead of put with 'filter false' you can simply use put -q. The following
+ uses the input record to accumulate data but only prints the running sum
+ without printing the input record:
- Please see http://johnkerl.org/miller/doc for more information.
-
-dump: prints all currently defined out-of-stream variables immediately
- to stdout as JSON.
-
- With >, >>, or |, the data do not become part of the output record stream but
- are instead redirected.
-
- The > and >> are for write and append, as in the shell, but (as with awk) the
- file-overwrite for > is on first write, not per record. The | is for piping to
- a process which will process the data. There will be one open file for each
- distinct file name (for > and >>) or one subordinate process for each distinct
- value of the piped-to command (for |). Output-formatting flags are taken from
- the main command line.
-
- Example: mlr --from f.dat put -q '@v[NR]=$*; end { dump }'
- Example: mlr --from f.dat put -q '@v[NR]=$*; end { dump > "mytap.dat"}'
- Example: mlr --from f.dat put -q '@v[NR]=$*; end { dump >> "mytap.dat"}'
- Example: mlr --from f.dat put -q '@v[NR]=$*; end { dump | "jq .[]"}'
-
-edump: prints all currently defined out-of-stream variables immediately
- to stderr as JSON.
-
- Example: mlr --from f.dat put -q '@v[NR]=$*; end { edump }'
+ Example: mlr --from f.dat put -q '@running_sum += $x * $y; emit @running_sum'
print: prints expression immediately to stdout.
Example: mlr --from f.dat put -q 'print "The sum of x and y is ".($x+$y)'
@@ -4735,19 +4712,41 @@ print: prints expression immediately to stdout.
printn: prints expression immediately to stdout, without trailing newline.
Example: mlr --from f.dat put -q 'printn "."; end { print "" }'
-eprint: prints expression immediately to stderr.
- Example: mlr --from f.dat put -q 'eprint "The sum of x and y is ".($x+$y)'
- Example: mlr --from f.dat put -q 'for (k, v in $*) { eprint k . " => " . v }'
- Example: mlr --from f.dat put '(NR % 1000 == 0) { eprint "Checkpoint ".NR}'
-
-eprintn: prints expression immediately to stderr, without trailing newline.
- Example: mlr --from f.dat put -q 'eprintn "The sum of x and y is ".($x+$y); eprint ""'
-
+stderr: Used for tee, emit, emitf, emitp, print, and dump in place of filename
+ to print to standard error.
stdout: Used for tee, emit, emitf, emitp, print, and dump in place of filename
to print to standard output.
-stderr: Used for tee, emit, emitf, emitp, print, and dump in place of filename
- to print to standard error.
+tee: prints the current record to specified file.
+ This is an immediate print to the specified file (except for pprint format
+ which of course waits until the end of the input stream to format all output).
+
+ The > and >> are for write and append, as in the shell, but (as with awk) the
+ file-overwrite for > is on first write, not per record. The | is for piping to
+ a process which will process the data. There will be one open file for each
+ distinct file name (for > and >>) or one subordinate process for each distinct
+ value of the piped-to command (for |). Output-formatting flags are taken from
+ the main command line.
+
+ You can use any of the output-format command-line flags, e.g. --ocsv, --ofs,
+ etc., to control the format of the output. See also mlr -h.
+
+ Example: mlr --from f.dat put 'tee > "/tmp/data-".$a, $*'
+ Example: mlr --from f.dat put 'tee >> "/tmp/data-".$a.$b, $*'
+ Example: mlr --from f.dat put 'tee > stderr, $*'
+ Example: mlr --from f.dat put -q 'tee | "tr [a-z\] [A-Z\]", $*'
+ Example: mlr --from f.dat put -q 'tee | "tr [a-z\] [A-Z\] > /tmp/data-".$a, $*'
+ Example: mlr --from f.dat put -q 'tee | "gzip > /tmp/data-".$a.".gz", $*'
+ Example: mlr --from f.dat put -q --ojson 'tee | "gzip > /tmp/data-".$a.".gz", $*'
+
+unset: clears field(s) from the current record, or an out-of-stream variable.
+
+ Example: mlr --from f.dat put 'unset $x'
+ Example: mlr --from f.dat put 'unset $*'
+ Example: mlr --from f.dat put 'for (k, v in $*) { if (k =~ "a.*") { unset $[k] } }'
+ Example: mlr --from f.dat put '...; unset @sums'
+ Example: mlr --from f.dat put '...; unset @sums["green"]'
+ Example: mlr --from f.dat put '...; unset @*'