From c9ff3676e5ae52f2e6272b4ef79e408eaff98e83 Mon Sep 17 00:00:00 2001 From: John Kerl Date: Mon, 12 Dec 2016 20:53:52 -0500 Subject: [PATCH] doc neaten --- c/todo.txt | 2 + doc/10-min.html | 2 +- doc/build.html | 2 +- doc/contact.html | 2 +- doc/content-for-manpage.html | 2 +- doc/content-for-reference-dsl.html | 4 +- doc/content-for-reference-verbs.html | 5 ++ doc/content-for-reference.html | 66 ++++++++++------- doc/cookbook.html | 104 +++++++++++++-------------- doc/data-examples.html | 2 +- doc/etymology.html | 2 +- doc/faq.html | 2 +- doc/feature-comparison.html | 2 +- doc/file-formats.html | 2 +- doc/index.html | 2 +- doc/internationalization.html | 2 +- doc/manpage.html | 4 +- doc/originality.html | 2 +- doc/performance.html | 2 +- doc/poki.cfg | 2 +- doc/record-heterogeneity.html | 2 +- doc/reference-dsl.html | 6 +- doc/reference-verbs.html | 7 +- doc/reference.html | 68 +++++++++++------- doc/release-docs.html | 2 +- doc/to-do.html | 2 +- doc/whyc.html | 2 +- 27 files changed, 175 insertions(+), 127 deletions(-) diff --git a/c/todo.txt b/c/todo.txt index 51ead41ce..65ec30eb0 100644 --- a/c/todo.txt +++ b/c/todo.txt @@ -419,6 +419,8 @@ DOC: ? tail -g - uniq -g +! stats1 antimode + ! more than 'syntax error' from lemon-parse failures ... lemon API research * stats1 for strings: min/max/percentiles. note count/mode already work. diff --git a/doc/10-min.html b/doc/10-min.html index 30dc7aa40..c1039acb5 100644 --- a/doc/10-min.html +++ b/doc/10-min.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/build.html b/doc/build.html index c7a801d67..c0f27bdef 100644 --- a/doc/build.html +++ b/doc/build.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/contact.html b/doc/contact.html index 2963be94f..4f730e8ed 100644 --- a/doc/contact.html +++ b/doc/contact.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/content-for-manpage.html b/doc/content-for-manpage.html index e47be30d6..16cce80e3 100644 --- a/doc/content-for-manpage.html +++ b/doc/content-for-manpage.html @@ -1,4 +1,4 @@ -

This is simply a copy of what you should see on running man mlr at +

This is simply a copy of what you should see on running man mlr at a command prompt, once Miller is installed on your system. POKI_INCLUDE_ESCAPED(manpage.txt)HERE diff --git a/doc/content-for-reference-dsl.html b/doc/content-for-reference-dsl.html index d1548b389..f72f7a1dc 100644 --- a/doc/content-for-reference-dsl.html +++ b/doc/content-for-reference-dsl.html @@ -142,7 +142,7 @@ cannot use these names for local variables. defined by Miller.

Miller supports the following five built-in variables for filter and put, all awk-inspired: +href="reference-verbs.html#filter">filter and put, all awk-inspired: NF, NR, FNR, FILENUM, and FILENAME, as well as the mathematical constants PI and E. Lastly, the ENV hashmap allows read access to environment @@ -179,7 +179,7 @@ not be assigned to: NR=100 is a syntax error.

Field names

Field names must be specified using a $ in filter and put expressions, even though the dollar signs +href="reference-verbs.html#put">put expressions, even though the dollar signs don’t appear in the data stream. For integer-indexed data, this looks like awk’s $1,$2,$3, except that Miller allows non-numeric names such as $quantity or $hostname. (Likewise, diff --git a/doc/content-for-reference-verbs.html b/doc/content-for-reference-verbs.html index fa90f477c..4b258a761 100644 --- a/doc/content-for-reference-verbs.html +++ b/doc/content-for-reference-verbs.html @@ -1,5 +1,10 @@ POKI_PUT_TOC_HERE +When you type mlr {something} myfile.dat, the {something} +part is called a verb. It specifies how you want to transform your data. +(See also here for a breakdown.) +The following is an alphabetical list of verbs with their descriptions. +

bar

diff --git a/doc/content-for-reference.html b/doc/content-for-reference.html index 58ce06ed1..3d391fdfa 100644 --- a/doc/content-for-reference.html +++ b/doc/content-for-reference.html @@ -17,14 +17,16 @@ POKI_INCLUDE_ESCAPED(data/subcommand-example.txt)HERE - cat, - cut, - head, - sort, - tac, - tail, - top, - uniq + cat, + cut, + grep, + head, + join, + sort, + tac, + tail, + top, + uniq Analogs of their Unix-toolkit namesakes, discussed below as well as in POKI_PUT_LINK_FOR_PAGE(feature-comparison.html)HERE @@ -32,27 +34,37 @@ POKI_INCLUDE_ESCAPED(data/subcommand-example.txt)HERE - filter, - put, - step + filter, + put, + sec2gmt, + sec2gmtdate, + step, + tee awk-like functionality - histogram, - stats1, - stats2 + bar, + bootstrap, + decimate, + histogram, + least-frequent, + most-frequent, + sample, + shuffle, + stats1, + stats2 Statistically oriented - group-by, - group-like, - having-fields + group-by, + group-like, + having-fields Particularly oriented toward POKI_PUT_LINK_FOR_PAGE(record-heterogeneity.html)HERE, although all Miller commands can handle heterogeneous records @@ -60,15 +72,21 @@ POKI_INCLUDE_ESCAPED(data/subcommand-example.txt)HERE - count-distinct, - label, - rename, - rename, - reorder + check, + count-distinct, + label, + merge-fields, + nest, + nothing, + rename, + rename, + reorder, + reshape, + seqgen These draw from other sources (see also POKI_PUT_LINK_FOR_PAGE(originality.html)HERE): - count-distinct is SQL-ish, and - rename can be done by sed (which does it faster: + count-distinct is SQL-ish, and + rename can be done by sed (which does it faster: see POKI_PUT_LINK_FOR_PAGE(performance.html)HERE). diff --git a/doc/cookbook.html b/doc/cookbook.html index 89cdae211..3c8eecac5 100644 --- a/doc/cookbook.html +++ b/doc/cookbook.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL @@ -607,33 +607,33 @@ $ mlr --ofmt '%.9lf' --opprint seqgen --start 1 --stop 28 then put ' ' then put '$seconds=systime()' then step -a delta -f seconds then cut -x -f seconds i o fcount seconds_delta 1 1 1 0 -2 2 3 0.000026941 -3 3 5 0.000012875 -4 5 9 0.000017166 -5 8 15 0.000022888 -6 13 25 0.000034094 -7 21 41 0.000047922 -8 34 67 0.000074148 -9 55 109 0.000124931 -10 89 177 0.000175953 +2 2 3 0.000025988 +3 3 5 0.000013113 +4 5 9 0.000015020 +5 8 15 0.000021935 +6 13 25 0.000033140 +7 21 41 0.000044823 +8 34 67 0.000071049 +9 55 109 0.000109911 +10 89 177 0.000176191 11 144 287 0.000279903 -12 233 465 0.000449181 -13 377 753 0.000722885 -14 610 1219 0.001163960 -15 987 1973 0.001880169 -16 1597 3193 0.003023863 -17 2584 5167 0.004923105 -18 4181 8361 0.007597923 -19 6765 13529 0.012258053 -20 10946 21891 0.019785881 -21 17711 35421 0.031752110 -22 28657 57313 0.050759077 -23 46368 92735 0.084112883 -24 75025 150049 0.135875940 -25 121393 242785 0.217002153 -26 196418 392835 0.339532852 -27 317811 635621 0.573457003 -28 514229 1028457 0.903333187 +12 233 465 0.000450134 +13 377 753 0.000890970 +14 610 1219 0.001194954 +15 987 1973 0.001878977 +16 1597 3193 0.003071070 +17 2584 5167 0.005360842 +18 4181 8361 0.008027077 +19 6765 13529 0.013869047 +20 10946 21891 0.023140907 +21 17711 35421 0.034433126 +22 28657 57313 0.055335999 +23 46368 92735 0.090437889 +24 75025 150049 0.141633034 +25 121393 242785 0.225202084 +26 196418 392835 0.367137909 +27 317811 635621 0.573060036 +28 514229 1028457 0.945078850

@@ -665,32 +665,32 @@ $ mlr --ofmt '%.9lf' --opprint seqgen --start 1 --stop 28 then put ' ' then put '$seconds=systime()' then step -a delta -f seconds then cut -x -f seconds i o fcount seconds_delta 1 1 1 0 -2 2 3 0.000027895 -3 3 3 0.000013113 -4 5 3 0.000010967 -5 8 3 0.000010967 -6 13 3 0.000010967 -7 21 3 0.000010967 -8 34 3 0.000010014 -9 55 3 0.000010967 -10 89 3 0.000010014 -11 144 3 0.000011206 -12 233 3 0.000013828 -13 377 3 0.000010967 -14 610 3 0.000010014 -15 987 3 0.000010014 -16 1597 3 0.000010014 -17 2584 3 0.000010967 -18 4181 3 0.000010014 -19 6765 3 0.000010014 -20 10946 3 0.000010014 +2 2 3 0.000031948 +3 3 3 0.000015020 +4 5 3 0.000013113 +5 8 3 0.000012875 +6 13 3 0.000011921 +7 21 3 0.000012159 +8 34 3 0.000011921 +9 55 3 0.000011921 +10 89 3 0.000012159 +11 144 3 0.000011921 +12 233 3 0.000015974 +13 377 3 0.000012159 +14 610 3 0.000011921 +15 987 3 0.000011921 +16 1597 3 0.000012159 +17 2584 3 0.000011921 +18 4181 3 0.000010967 +19 6765 3 0.000011921 +20 10946 3 0.000011206 21 17711 3 0.000011921 -22 28657 3 0.000010014 -23 46368 3 0.000012159 -24 75025 3 0.000010967 -25 121393 3 0.000010014 -26 196418 3 0.000010967 -27 317811 3 0.000010014 +22 28657 3 0.000014067 +23 46368 3 0.000013828 +24 75025 3 0.000012159 +25 121393 3 0.000011921 +26 196418 3 0.000011921 +27 317811 3 0.000013113 28 514229 3 0.000010967 diff --git a/doc/data-examples.html b/doc/data-examples.html index 221b28b60..44b16a209 100644 --- a/doc/data-examples.html +++ b/doc/data-examples.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/etymology.html b/doc/etymology.html index b384f415a..82e7ff3cc 100644 --- a/doc/etymology.html +++ b/doc/etymology.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/faq.html b/doc/faq.html index eb7eb91f2..50680d1ba 100644 --- a/doc/faq.html +++ b/doc/faq.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/feature-comparison.html b/doc/feature-comparison.html index 080c1ab4b..e822fd571 100644 --- a/doc/feature-comparison.html +++ b/doc/feature-comparison.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/file-formats.html b/doc/file-formats.html index b54e3dc9f..1f6ff0b1f 100644 --- a/doc/file-formats.html +++ b/doc/file-formats.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/index.html b/doc/index.html index 19f61642e..a60bab739 100644 --- a/doc/index.html +++ b/doc/index.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/internationalization.html b/doc/internationalization.html index d5c470edd..b06773f70 100644 --- a/doc/internationalization.html +++ b/doc/internationalization.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/manpage.html b/doc/manpage.html index ccb60af16..92df14a83 100644 --- a/doc/manpage.html +++ b/doc/manpage.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL @@ -141,7 +141,7 @@ Miller commands were run with pretty-print-tabular output format.

-

This is simply a copy of what you should see on running man mlr at +

This is simply a copy of what you should see on running man mlr at a command prompt, once Miller is installed on your system.

diff --git a/doc/originality.html b/doc/originality.html index 6da20a90d..7e1dd2c89 100644 --- a/doc/originality.html +++ b/doc/originality.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/performance.html b/doc/performance.html index 4b951dfbd..dcb8dd49e 100644 --- a/doc/performance.html +++ b/doc/performance.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/poki.cfg b/doc/poki.cfg index 1bf9e2f12..05454044a 100644 --- a/doc/poki.cfg +++ b/doc/poki.cfg @@ -8,9 +8,9 @@ internationalization.html Internationalization sep:details Using Miller: faq.html FAQ -manpage.html Manpage data-examples.html Data-diving examples cookbook.html Cookbook +manpage.html Manpage reference.html Reference reference-verbs.html Reference: Verbs reference-dsl.html Reference: DSL diff --git a/doc/record-heterogeneity.html b/doc/record-heterogeneity.html index 6320b4921..841113bfa 100644 --- a/doc/record-heterogeneity.html +++ b/doc/record-heterogeneity.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/reference-dsl.html b/doc/reference-dsl.html index ef8759e9a..7c0226c9c 100644 --- a/doc/reference-dsl.html +++ b/doc/reference-dsl.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL @@ -520,7 +520,7 @@ cannot use these names for local variables. defined by Miller.

Miller supports the following five built-in variables for filter and put, all awk-inspired: +href="reference-verbs.html#filter">filter and put, all awk-inspired: NF, NR, FNR, FILENUM, and FILENAME, as well as the mathematical constants PI and E. Lastly, the ENV hashmap allows read access to environment @@ -610,7 +610,7 @@ not be assigned to: NR=100 is a syntax error.

Field names

Field names must be specified using a $ in filter and put expressions, even though the dollar signs +href="reference-verbs.html#put">put expressions, even though the dollar signs don’t appear in the data stream. For integer-indexed data, this looks like awk’s $1,$2,$3, except that Miller allows non-numeric names such as $quantity or $hostname. (Likewise, diff --git a/doc/reference-verbs.html b/doc/reference-verbs.html index 8eeb7b41d..826adcc40 100644 --- a/doc/reference-verbs.html +++ b/doc/reference-verbs.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL @@ -189,6 +189,11 @@ Miller commands were run with pretty-print-tabular output format.

+When you type mlr {something} myfile.dat, the {something} +part is called a verb. It specifies how you want to transform your data. +(See also here for a breakdown.) +The following is an alphabetical list of verbs with their descriptions. +

bar

diff --git a/doc/reference.html b/doc/reference.html index d36fcc829..beaf34483 100644 --- a/doc/reference.html +++ b/doc/reference.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL @@ -191,14 +191,16 @@ mlr sort -f hostname,uptime *.dat - cat, - cut, - head, - sort, - tac, - tail, - top, - uniq + cat, + cut, + grep, + head, + join, + sort, + tac, + tail, + top, + uniq Analogs of their Unix-toolkit namesakes, discussed below as well as in Miller features in the context of the Unix toolkit @@ -206,27 +208,37 @@ mlr sort -f hostname,uptime *.dat - filter, - put, - step + filter, + put, + sec2gmt, + sec2gmtdate, + step, + tee awk-like functionality - histogram, - stats1, - stats2 + bar, + bootstrap, + decimate, + histogram, + least-frequent, + most-frequent, + sample, + shuffle, + stats1, + stats2 Statistically oriented - group-by, - group-like, - having-fields + group-by, + group-like, + having-fields Particularly oriented toward Record-heterogeneity, although all Miller commands can handle heterogeneous records @@ -234,15 +246,21 @@ mlr sort -f hostname,uptime *.dat - count-distinct, - label, - rename, - rename, - reorder + check, + count-distinct, + label, + merge-fields, + nest, + nothing, + rename, + rename, + reorder, + reshape, + seqgen These draw from other sources (see also How original is Miller?): - count-distinct is SQL-ish, and - rename can be done by sed (which does it faster: + count-distinct is SQL-ish, and + rename can be done by sed (which does it faster: see Performance). diff --git a/doc/release-docs.html b/doc/release-docs.html index f39f75dce..95021ab8a 100644 --- a/doc/release-docs.html +++ b/doc/release-docs.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/to-do.html b/doc/to-do.html index 08d7d5010..98bdcfd99 100644 --- a/doc/to-do.html +++ b/doc/to-do.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL diff --git a/doc/whyc.html b/doc/whyc.html index dc5f06cee..5a65a1829 100644 --- a/doc/whyc.html +++ b/doc/whyc.html @@ -72,9 +72,9 @@ Miller commands were run with pretty-print-tabular output format.
• Internationalization
Using Miller:
• FAQ -
• Manpage
• Data-diving examples
• Cookbook +
• Manpage
• Reference
• Reference: Verbs
• Reference: DSL