-| do | ( -- ? ) Execute an action. |
- | push | ( [] -- [] ) Push a value into a quote as its new last value. |
- | version | ( -- ) Produce the version of dt in use. |
+| do | ( <action> -- ? ) Execute an action. |
+ | push | ( [<a>] <b> -- [<c>] ) Push a value into a quote as its new last value. |
+ | version | ( -- <version> ) Produce the version of dt in use. |
| status | ( -- ) Print the state of the process: all available values. |
- | deq | ( [] -- [] ) Dequeue the first value from a quote. |
- | % | ( -- ) Modulo two numeric values. In standard notation: a % b = c |
- | chars | ( -- [] ) Splits a string into individual characters, where a character is a single byte. (Not friendly to UTF-8 runes.) |
+ | deq | ( [<a>] -- <b> [<c>] ) Dequeue the first value from a quote. |
+ | % | ( <a> <b> -- <c> ) Modulo two numeric values. In standard notation: a % b = c |
+ | chars | ( <string> -- [<substring>] ) Splits a string into individual characters, where a character is a single byte. (Not friendly to UTF-8 runes.) |
| pipe-thru-args | pipe-thru-args |
| repl-prelude | repl-prelude |
- | dup | ( -- ) Duplicate the most recent value. |
- | * | ( -- ) Multiply two numeric values. |
- | eprintlns | ( [] -- ) Print the values of the most recent quote, each followed by a newline, to standard error. |
- | swap | ( -- ) Swap the two most recent values. |
- | len | ( -- ) The length of a string or quote. (Always 1 for single values.) |
- | quote | ( -- [] ) Quote a value. |
- | gte? | ( -- ) Determine if a number is greater-than/equal-to another. In standard notation: a ≧ b |
- | readf | ( -- ) Read a file's contents as a string. |
- | join | ( [] -- ) Join strings with a delimiter. |
- | ep | ( -- ) Print the most recent value to standard error. |
- | to-float | ( -- ) Coerce a value to a floating-point number. |
+ | dup | ( <a> -- <a> <a> ) Duplicate the most recent value. |
+ | * | ( <a> <b> -- <c> ) Multiply two numeric values. |
+ | eprintlns | ( [<a>] -- ) Print the values of the most recent quote, each followed by a newline, to standard error. |
+ | swap | ( <a> <b> -- <b> <a> ) Swap the two most recent values. |
+ | len | ( <a> -- <length> ) The length of a string or quote. (Always 1 for single values.) |
+ | quote | ( <a> -- [<a>] ) Quote a value. |
+ | gte? | ( <a> <b> -- <bool> ) Determine if a number is greater-than/equal-to another. In standard notation: a ≧ b |
+ | readf | ( <filename> -- <contents> ) Read a file's contents as a string. |
+ | join | ( [<substring>] <delim> -- <string> ) Join strings with a delimiter. |
+ | ep | ( <a> -- ) Print the most recent value to standard error. |
+ | to-float | ( <a> -- <float> ) Coerce a value to a floating-point number. |
| run-args | run-args |
- | doin | ( -- ) Execute an action in a context. |
- | even? | ( -- ) Determine if a number is even. |
- | neq? | ( -- ) Determine if two values are unequal. |
- | divisor? | ( -- ) Determine if a number a is evenly divisible by number b. |
- | first | ( [] -- ) The first element of a quote. |
- | do? | ( -- ? ) Conditionally execute an action. |
+ | doin | ( <context> <action> -- ) Execute an action in a context. |
+ | even? | ( <a> -- <bool> ) Determine if a number is even. |
+ | neq? | ( <a> <b> -- <bool> ) Determine if two values are unequal. |
+ | divisor? | ( <a> <b> -- <bool> ) Determine if a number a is evenly divisible by number b. |
+ | first | ( [<a>] -- <b> ) The first element of a quote. |
+ | do? | ( <action> <condition> -- ? ) Conditionally execute an action. |
| enl | ( -- ) Print a newline to standard error. |
- | parse-csv | ( -- [[]] ) Naive conversion of a raw string in comma-separated value (CSV) format to a quote of lines of cells |
+ | parse-csv | ( <string> -- [[<cells>]] ) Naive conversion of a raw string in comma-separated value (CSV) format to a quote of lines of cells |
| .s | ( -- ) Print the state of the process: all available values. |
- | drop | ( -- ) Drop the most recent value. |
- | + | ( -- ) Add two numeric values. |
- | to-bool | ( -- ) Coerce a value to a boolean. |
- | inspire | ( -- ) Get inspiration. |
- | pl | ( -- ) Print the most recent value and a newline to standard output. |
- | println | ( -- ) Print the most recent value and a newline to standard output. |
- | assert-true | ( -- ) Naive assertion that requires a condition to be truthy. If falsy, it will print a message to standard error and fail with an exit code of 1. |
- | def! | ( -- ) Defines a new command. If nested, any commands or variables defined will be available in the calling scope. |
- | map | ( -- ) Apply an action to all values in a quote. |
- | upcase | ( -- ) Convert a string to its uppercase form. |
- | undef? | ( -- ) Determine whether a command is undefined. |
- | each | ( [] -- ) Perform a given action with each value in a quote. |
- | lte? | ( -- ) Determine if a number is less-than/equal-to another. In standard notation: a ≦ b |
- | last | ( [] -- ) The last element of a quote. |
- | cwd | ( -- ) Produce the current working directory. |
- | writef | ( -- ) Write a string as a file. If a file previously existed, it will be overwritten. |
- | def? | ( -- ) Determine whether a command is defined. |
- | to-quote | ( -- [] ) Coerce value to a quote. To quote a quote, use quote. |
- | while | ( -- ? ) Perform an action while the condition is truthy. |
- | alias | ( -- ) Alias a new command from another, copying the description of the previous command. |
- | abs | ( -- ) Determine the absolute value of a number. |
- | defs | ( -- [] ) Produce a quote of all defined commands. |
- | not | ( -- ) Determine the inverse truthiness of a value. |
- | read-lines | ( -- [] ) Read strings, separated by newlines, from standard input until EOF. (For example: until ctrl+d in a unixy system, or until a pipe is closed.) |
- | rot | ( -- ) Rotate the three most recent values. |
+ | drop | ( <a> -- ) Drop the most recent value. |
+ | + | ( <a> <b> -- <c> ) Add two numeric values. |
+ | to-bool | ( <a> -- <bool> ) Coerce a value to a boolean. |
+ | inspire | ( -- <wisdom> ) Get inspiration. |
+ | pl | ( <a> -- ) Print the most recent value and a newline to standard output. |
+ | println | ( <a> -- ) Print the most recent value and a newline to standard output. |
+ | assert-true | ( <cond> <message> -- ) Naive assertion that requires a condition to be truthy. If falsy, it will print a message to standard error and fail with an exit code of 1. |
+ | def! | ( <action> <name> -- ) Defines a new command. If nested, any commands or variables defined will be available in the calling scope. |
+ | map | ( <original> <action> -- <transformed> ) Apply an action to all values in a quote. |
+ | upcase | ( <string> -- <upper> ) Convert a string to its uppercase form. |
+ | undef? | ( <name> -- <bool> ) Determine whether a command is undefined. |
+ | each | ( [<a>] <action> -- ) Perform a given action with each value in a quote. |
+ | lte? | ( <a> <b> -- <bool> ) Determine if a number is less-than/equal-to another. In standard notation: a ≦ b |
+ | last | ( [<a>] -- <b> ) The last element of a quote. |
+ | cwd | ( -- <dirname> ) Produce the current working directory. |
+ | writef | ( <contents> <filename> -- ) Write a string as a file. If a file previously existed, it will be overwritten. |
+ | def? | ( <name> -- <bool> ) Determine whether a command is defined. |
+ | to-quote | ( <a> -- [<a>] ) Coerce value to a quote. To quote a quote, use quote. |
+ | while | ( <action> <cond> -- ? ) Perform an action while the condition is truthy. |
+ | alias | ( <prevname> <newname> -- ) Alias a new command from another, copying the description of the previous command. |
+ | abs | ( <a> -- <b> ) Determine the absolute value of a number. |
+ | defs | ( -- [<name>] ) Produce a quote of all defined commands. |
+ | not | ( <a> -- <bool> ) Determine the inverse truthiness of a value. |
+ | read-lines | ( -- [<line>] ) Read strings, separated by newlines, from standard input until EOF. (For example: until ctrl+d in a unixy system, or until a pipe is closed.) |
+ | rot | ( <a> <b> <c> -- <c> <a> <b> ) Rotate the three most recent values. |
| red | ( -- ) Print a control character for red to standard output and standard error. |
- | args | ( -- [] ) Produce the arguments provided to the process when it was launched. |
- | interactive? | ( -- ) Determine if the input mode is interactive (a TTY) or not. |
- | do! | ( -- ? ) Execute an action. If nested, any commands or variables defined will be available in the calling scope. |
- | concat | ( [] [] -- [] ) Concatenate two quotes. Values are coerced into quotes. (For String concatenation, see join.) |
- | unwords | ( [] -- ) Joins strings with spaces. |
- | to-string | ( -- ) Coerce a value to a string. |
- | nand | ( -- ) Determine if two values are not both truthy. |
+ | args | ( -- [<arg>] ) Produce the arguments provided to the process when it was launched. |
+ | interactive? | ( -- <bool> ) Determine if the input mode is interactive (a TTY) or not. |
+ | do! | ( <action> -- ? ) Execute an action. If nested, any commands or variables defined will be available in the calling scope. |
+ | concat | ( [<a>] [<b>] -- [<c>] ) Concatenate two quotes. Values are coerced into quotes. (For String concatenation, see join.) |
+ | unwords | ( [<substring>] -- <string> ) Joins strings with spaces. |
+ | to-string | ( <a> -- <string> ) Coerce a value to a string. |
+ | nand | ( <a> <b> -- <bool> ) Determine if two values are not both truthy. |
| main-repl | main-repl |
- | do!? | ( -- ? ) Conditionally execute an action. If nested, any commands or variables defined will be available in the calling scope. |
- | rand | ( -- ) Produces a random integer. |
- | read-line | ( -- ) Read a string from standard input until newline. |
- | quote-all | ( ? -- [] ) Quote all current context. |
+ | do!? | ( <action> <condition> -- ? ) Conditionally execute an action. If nested, any commands or variables defined will be available in the calling scope. |
+ | rand | ( -- <a> ) Produces a random integer. |
+ | read-line | ( -- <line> ) Read a string from standard input until newline. |
+ | quote-all | ( ? -- [<?>] ) Quote all current context. |
| print-version | print-version |
- | words | ( -- [] ) Splits a string on spaces. |
- | epls | ( [] -- ) Print the values of the most recent quote, each followed by a newline, to standard error. |
+ | words | ( <string> -- [<substring>] ) Splits a string on spaces. |
+ | epls | ( [<a>] -- ) Print the values of the most recent quote, each followed by a newline, to standard error. |
| --version | --version |
- | downcase | ( -- ) Convert a string to its lowercase form. |
- | ls | ( -- [] ) Produce a quote of files and directories in the process's working directory. |
- | appendf | ( -- ) Write a string to a file. If a file previously existed, the new content will be appended. |
- | or | ( -- ) Determine if either of two values are truthy. |
- | unlines | ( [] -- ) Joins strings with newlines. |
- | exit | ( -- ) Exit with the specified exit code. |
+ | downcase | ( <string> -- <lower> ) Convert a string to its lowercase form. |
+ | ls | ( -- [<filename>] ) Produce a quote of files and directories in the process's working directory. |
+ | appendf | ( <contents> <filename> -- ) Write a string to a file. If a file previously existed, the new content will be appended. |
+ | or | ( <a> <b> -- <bool> ) Determine if either of two values are truthy. |
+ | unlines | ( [<substring>] -- <string> ) Joins strings with newlines. |
+ | exit | ( <exitcode> -- ) Exit with the specified exit code. |
| pwd | ( -- ) Print the current working directory to standard output. |
- | cd | ( -- ) Change the process's working directory. |
- | to-def | ( -- ) Coerce a value to a deferred command. (Read as "definition" or "deferred".) |
+ | cd | ( <dirname> -- ) Change the process's working directory. |
+ | to-def | ( <a> -- <def> ) Coerce a value to a deferred command. (Read as "definition" or "deferred".) |
| eval | eval |
- | eq? | ( -- ) Determine if two values are equal. Works for most types with coersion. |
- | any? | ( -- ) Determine whether any value in a quote passes a condition. Stops at the first truthy result. |
- | def | ( -- ) Define a command. |
- | gt? | ( -- ) Determine if a number is greater than another. In standard notation: a > b |
- | unquote | ( -- ? ) Unpack a quote. |
+ | eq? | ( <a> <b> -- <bool> ) Determine if two values are equal. Works for most types with coersion. |
+ | any? | ( <original> <condition> -- <bool> ) Determine whether any value in a quote passes a condition. Stops at the first truthy result. |
+ | def | ( <action> <name> -- ) Define a command. |
+ | gt? | ( <a> <b> -- <bool> ) Determine if a number is greater than another. In standard notation: a > b |
+ | unquote | ( <original> -- ? ) Unpack a quote. |
| repl-greet | repl-greet |
- | pls | ( [] -- ) Print the values of the most recent quote, each followed by a newline, to standard output. |
- | anything? | ( -- ) True if any value is present. |
- | : | ( ... [] -- ) Bind variables to a quote of names. |
- | lt? | ( -- ) Determine if a number is less than another. In standard notation: a < b |
- | def-usage | ( -- ) Define the usage notes of a given command. |
- | ends-with? | ( -- ) Determine if a string ends with a suffix. |
- | exec | ( -- ) Execute a child process (from a String). When successful, returns stdout as a string. When unsuccessful, prints the child's stderr to stderr, and returns boolean false. |
- | to-cmd | ( -- ) Coerce a value to a command. |
+ | pls | ( [<a>] -- ) Print the values of the most recent quote, each followed by a newline, to standard output. |
+ | anything? | ( -- <bool> ) True if any value is present. |
+ | : | ( ... [<name>] -- ) Bind variables to a quote of names. |
+ | lt? | ( <a> <b> -- <bool> ) Determine if a number is less than another. In standard notation: a < b |
+ | def-usage | ( <name> <description> -- ) Define the usage notes of a given command. |
+ | ends-with? | ( <string> <suffix> -- <bool> ) Determine if a string ends with a suffix. |
+ | exec | ( <process> -- ) Execute a child process (from a String). When successful, returns stdout as a string. When unsuccessful, prints the child's stderr to stderr, and returns boolean false. |
+ | to-cmd | ( <a> -- <cmd> ) Coerce a value to a command. |
| shebang-args | shebang-args |
- | starts-with? | ( -- ) Determine if a string starts with a prefix. |
+ | starts-with? | ( <string> <prefix> -- <bool> ) Determine if a string starts with a prefix. |
| norm | ( -- ) Print a control character to reset any styling to standard output and standard error. |
- | eprintln | ( -- ) Print the most recent value and a newline to standard error. |
- | pop | ( [] -- [] ) Pop the last value from a quote. |
- | odd? | ( -- ) Determine if a number is odd. |
- | print | ( -- ) Print the most recent value to standard output. |
- | procname | ( -- ) Produce the name of the current process. This can be used, for example, to get the name of a shebang script. |
- | split | ( -- [] ) Split a string on all occurrences of a delimiter. |
+ | eprintln | ( <a> -- ) Print the most recent value and a newline to standard error. |
+ | pop | ( [<a>] -- [<b>] <c> ) Pop the last value from a quote. |
+ | odd? | ( <a> -- <bool> ) Determine if a number is odd. |
+ | print | ( <a> -- ) Print the most recent value to standard output. |
+ | procname | ( -- <name> ) Produce the name of the current process. This can be used, for example, to get the name of a shebang script. |
+ | split | ( <string> <delim> -- [<substring>] ) Split a string on all occurrences of a delimiter. |
| green | ( -- ) Print a control character for green and bold (for the colorblind) to standard output and standard error. |
- | rev | ( -- ) Reverse a quote or string. Other types are unmodified. |
- | epl | ( -- ) Print the most recent value and a newline to standard error. |
- | times | ( -- ? ) Perform a given action n times. |
+ | rev | ( <original> -- <reversed> ) Reverse a quote or string. Other types are unmodified. |
+ | epl | ( <a> -- ) Print the most recent value and a newline to standard error. |
+ | times | ( <action> <n> -- ? ) Perform a given action n times. |
| handle-flags | handle-flags |
| quit | ( -- ) Quit. Prints a warning if there are any values left on stack. |
- | to-int | ( -- ) Coerce a value to an integer. |
- | printlns | ( [] -- ) Print the values of the most recent quote, each followed by a newline, to standard output. |
+ | to-int | ( <a> -- <int> ) Coerce a value to an integer. |
+ | printlns | ( [<a>] -- ) Print the values of the most recent quote, each followed by a newline, to standard output. |
| handle-flag | handle-flag |
- | / | ( -- ) Divide two numeric values. In standard notation: a / b = c |
- | lines | ( -- [] ) Splits a string on newlines. |
- | - | ( -- ) Subtract two numeric values. In standard notation: a - b = c |
- | contains? | ( -- ) With Strings, determine if a string contains a substring. With quotes, determine if a quote contains a value. |
- | eprint | ( -- ) Print the most recent value to standard error. |
- | ... | ( -- ? ) Unpack a quote. |
+ | / | ( <a> <b> -- <c> ) Divide two numeric values. In standard notation: a / b = c |
+ | lines | ( <string> -- [<substring>] ) Splits a string on newlines. |
+ | - | ( <a> <b> -- <c> ) Subtract two numeric values. In standard notation: a - b = c |
+ | contains? | ( <haystack> <needle> -- <bool> ) With Strings, determine if a string contains a substring. With quotes, determine if a quote contains a value. |
+ | eprint | ( <a> -- ) Print the most recent value to standard error. |
+ | ... | ( <original> -- ? ) Unpack a quote. |
| print-help | print-help |
- | usage | ( -- ) Print the usage notes of a given command. |
- | and | ( -- ) Determine if two values are both truthy. |
- | nor | ( -- ) Determine if neither of two values are truthy. |
- | filter | ( -- ) Require some condition of all values in a quote. Truthy results are preserved, and falsy results are not. |
+ | usage | ( <name> -- <description> ) Print the usage notes of a given command. |
+ | and | ( <a> <b> -- <bool> ) Determine if two values are both truthy. |
+ | nor | ( <a> <b> -- <bool> ) Determine if neither of two values are truthy. |
+ | filter | ( <original> <condition> -- <preserved> ) Require some condition of all values in a quote. Truthy results are preserved, and falsy results are not. |
| --help | --help |
| repl | repl |
- | p | ( -- ) Print the most recent value to standard output. |
+ | p | ( <a> -- ) Print the most recent value to standard output. |
| nl | ( -- ) Print a newline to standard output. |
- | enq | ( [] -- [] ) Enqueue a value into a quote as its new first value. |
- | define | ( -- ) Define a command with a description. |
+ | enq | ( <a> [<b>] -- [<c>] ) Enqueue a value into a quote as its new first value. |
+ | define | ( <action> <description> <name> -- ) Define a command with a description. |
diff --git a/gen-docs.dt b/gen-docs.dt
index 9181174..6563051 100755
--- a/gen-docs.dt
+++ b/gen-docs.dt
@@ -25,10 +25,14 @@ defs \FROZEN_DEFS :
"