(index ("terminal-info" 0) ("get-terminal-size" 385) ("get-terminal-name" 646) ("output-port-width" 893) ("output-port-height" 1179) ("string-trim-eol" 1435) ("software-eol-string" 1634) ("environment-string" 1771) ("environment-variables->environment-list" 1984) ("qs*" 2232) ("qs-quote" 2354) ("qs-string" 2455) ("qs-argument" 2560) ("get-commandline-result" 3421) ("get-command-result" 3666) ("get-echo-result" 3953) ("environment-variable-bound?" 4155) ("environment-variable-true?" 4546) ("register-environment-variable-feature!" 5037) ("get-shell-variable" 5361) ("shell-variable-bound?" 5546) ("shell-variable-true?" 5763) ("register-shell-variable-feature!" 6088))
(def (sig (procedure "(terminal-info [PORT]) --> alist" (id terminal-info))) (p "Returns " (tt "alist") " of terminal properties for " (tt "PORT") ".") (p ": " (tt "PORT") " ; " (tt "output-port") " ; " (tt "current-output-port")) (p "Known terminal properties:") (p ": " (tt "name") " ; " (tt "string") " : " (tt "width") " ; " (tt "fixnum") " : " (tt "height") " ; " (tt "fixnum")))
(def (sig (procedure "(get-terminal-size [PORT]) --> (or boolean (list fixnum fixnum))" (id get-terminal-size))) (p "Returns terminal size or " (tt "#f") " when " (tt "PORT") " is not a " (tt "terminal-port") ".") (p ": " (tt "PORT") " ; " (tt "output-port")))
(def (sig (procedure "(get-terminal-name [PORT]) --> (or boolean string)" (id get-terminal-name))) (p "Returns terminal name or " (tt "#f") " when " (tt "PORT") " is not a " (tt "terminal-port") ".") (p ": " (tt "PORT") " ; " (tt "output-port")))
(def (sig (procedure "(output-port-width PORT [DEF]) --> fixnum" (id output-port-width))) (p "Returns terminal width or " (tt "DEF") " when " (tt "PORT") " is not a " (tt "terminal-port") ".") (p ": " (tt "PORT") " ; " (tt "(or boolean output-port)") " ; " (tt "current-output-port")))
(def (sig (procedure "(output-port-height PORT [DEF]) --> fixnum" (id output-port-height))) (p "Returns terminal height or " (tt "DEF") " when " (tt "PORT") " is not a " (tt "terminal-port") ".") (p ": " (tt "PORT") " ; " (tt "(or boolean output-port)")))
(def (sig (procedure "(string-trim-eol STR) -> string" (id string-trim-eol))) (p "Removes last instance of the platform dependent EOL character sequence from the " (tt "string") " " (tt "STR") "."))
(def (sig (constant "software-eol-string" (id software-eol-string))) (p "Platform dependent EOL character sequence " (tt "string") "."))
(def (sig (procedure "(environment-string CELL) -> string" (id environment-string))) (p "Returns " (tt "\"VAR=VAL\"") ", where " (tt "VAR") " is " (tt "(car CELL)") " & " (tt "VAL") " is " (tt "(cdr CELL)") "."))
(def (sig (procedure "(environment-variables->environment-list EVS) -> (list-of string)" (id environment-variables->environment-list))) (p "Returns a list of " (tt "\"VAR=VAL\"") " from the environment variables association-list " (tt "EVS") "."))
(def (sig (procedure "(qs* STR [DELIM #\\\"]) -> string" (id qs*))) (p "Result like " (tt "(conc DELIM STR DELIM)") "."))
(def (sig (procedure "(qs-quote OBJ) -> string" (id qs-quote))) (p "Returns " (tt "\"'OBJ'\"") "."))
(def (sig (procedure "(qs-string OBJ) -> string" (id qs-string))) (p "Returns " (tt "\"\"OBJ\"\"") "."))
(def (sig (procedure "(qs-argument OBJ [LITERAL? [DELIM #\\\"]]) -> string" (id qs-argument))) (p "Returns a " (i "quoted") ", " (i "quasiquoted") ", or " (i "evaluated") " shell argument string.") (p "An " (tt "OBJ") " is") (dl (dt "'* (quote . *)") (dd (i "quoted") " " (tt "*") " unless " (tt "LITERAL?")) (dt "`* (quasiquote . *)") (dd (i "quasiquoted") " " (tt "*") " unless " (tt "LITERAL?")) (dt "*") (dd (i "evaluated"))) (p "A " (i "shell") " quote is") (dl (dt (i "quoted")) (dd (tt "' string '")) (dt (i "quasiquoted")) (dd (tt "` ,* (unquote *) | ,@* (unquote-splicing *) | * (quote) `")) (dt (i "evaluated")) (dd (tt "\" string \""))) (p "A " (i "quasiquoted") " " (tt "OBJ") " is") (dl (dt ",* (unquote *)") (dd (i "evaluated") " *") (dt ",@* (unquote-splicing *)") (dd (i "evaluated") " * #\\space ...") (dt "* (quote)") (dd (i "quoted") " *")))
(def (sig (procedure "(get-commandline-result CMND LINE) -> string" (id get-commandline-result))) (p "Returns the result of " (tt "''shell'' CMND LINE") ".") (p (tt "CMND") " is a " (tt "string") ".") (p (tt "LINE") " is a " (tt "string") "."))
(def (sig (procedure "(get-command-result CMND ARG ...) -> string" (id get-command-result))) (p "Returns the result of " (tt "''shell'' CMND ARG ...") ".") (p (tt "CMND") " is a " (tt "string") ".") (p (tt "ARG ...") " are " (tt "string ...") " & processed by " (tt "qs-argument") "."))
(def (sig (procedure "(get-echo-result EXP) -> string" (id get-echo-result))) (p "Returns the result of " (tt "echo \"EXP\"") ", w/o the " (i "echo") " eol.") (p (tt "EXP") " is a " (tt "string") "."))
(def (sig (procedure "(environment-variable-bound? NAME) -> (or boolean string)" (id environment-variable-bound?))) (p "Does the environment variable " (tt "NAME") " exist with a non-null value?") (p (tt "NAME") " is a " (tt "string") ".") (highlight scheme "FOO=1 BAR= csi -q -R posix-utils\n#;1> (environment-variable-bound? \"FOO\")\n#t\n#;2> (environment-variable-bound? \"BAR\")\n#f"))
(def (sig (procedure "(environment-variable-true? NAME [TRUTHS (\"y\" \"yes\" \"1\")]) -> boolean" (id environment-variable-true?))) (p "Is the environment variable " (tt "NAME") " lowercase value in " (tt "TRUTHS") "?") (p (tt "NAME") " is a " (tt "string") ". " (tt "TRUTHS") " is a " (tt "(list-of string)") " recognized as true values.") (highlight scheme "FOO=1 BAR= csi -q -R posix-utils\n#;1> (environment-variable-true? \"FOO\")\n#t\n#;2> (environment-variable-true? \"BAR\")\n#f"))
(def (sig (procedure "(register-environment-variable-feature! NAME) -> (or boolean symbol)" (id register-environment-variable-feature!))) (p "Registers an existing " (tt "NAME") " value as a " (tt "feature") ". Returns " (tt "#f") " or the registered feature " (tt "symbol") ".") (p (tt "NAME") " is a " (tt "string") "."))
(def (sig (procedure "(get-shell-variable NAME) -> string" (id get-shell-variable))) (p "Returns the shell variable " (tt "NAME") " value.") (p (tt "NAME") " is a " (tt "string") "."))
(def (sig (procedure "(shell-variable-bound? NAME) -> (or boolean string)" (id shell-variable-bound?))) (p "Does the shell variable " (tt "NAME") " have a non-null value?") (p (tt "NAME") " is a " (tt "string") "."))
(def (sig (procedure "(shell-variable-true? NAME [TRUTHS (\"y\" \"yes\" \"1\")]) -> boolean" (id shell-variable-true?))) (p "Is the shell variable " (tt "NAME") " lowercase value in " (tt "TRUTHS") "?") (p (tt "NAME") " is a " (tt "string") ". " (tt "TRUTHS") " is a " (tt "(list-of string)") " recognized as true values."))
(def (sig (procedure "(register-shell-variable-feature! NAME) -> (or boolean symbol)" (id register-shell-variable-feature!))) (p "Registers an existing " (tt "NAME") " value as a " (tt "feature") ". Returns " (tt "#f") " or the registered feature " (tt "symbol") ".") (p (tt "NAME") " is a " (tt "string") ".") (highlight scheme "#;1> (register-shell-variable-feature! \"OSTYPE\")\ndarwin7 ;ymmv"))
