(index ("string" 0) ("kvlist" 74) ("boolean" 225) ("boolean" 434) ("boolean" 671) ("boolean" 862) ("use-legacy-bindings" 1035) ("readline" 1428) ("%signal-cleanup" 1643) ("clear-history" 1924) ("read-history" 2018) ("write-history" 2252) ("append-history" 2571) ("history-newlines" 2790) ("truncate-history" 2929) ("install-history-file" 3153) ("make-readline-port" 3916) ("set-bounce-ms" 4344) ("parse-and-bind" 4569) ("history-list" 4759) ("history-position" 4878) ("%history-add%" 5082) ("%remove-history%" 5300) ("eval-last-history-line" 5463))
(def (sig (type "string" (id string))) (p "The current version string."))
(def (sig (type "kvlist" (id kvlist))) (p "A Key-value list of settings that affect how some of the egg's functions behave for the current session."))
(def (sig (type "boolean" (id boolean))) (p "Used by " (tt "install-history-file") ".  Set to " (tt "#t") " by default; when set to " (tt "#f") ", the history file will " (b "NOT") " be loaded at start-up."))
(def (sig (type "boolean" (id boolean))) (p "Used by " (tt "install-history-file") ".  Set to " (tt "#t") " by default; when set to " (tt "#f") ", the current session's history will " (b "NOT") " be saved to the history file on exit."))
(def (sig (type "boolean" (id boolean))) (p "Used by " (tt ",rl-rec") ".  Set to " (tt "#t") " by default; when set to " (tt "#f") " it disables recording history for the current session."))
(def (sig (type "boolean" (id boolean))) (p "Settings this to true makes " (tt ",rl-!!") " wait for you to press enter instead of inserting " (tt "EOL") " automatically."))
(def (sig (procedure "(use-legacy-bindings)" (id use-legacy-bindings))) (p "Exports symbols aliasing the v1.993 API to the current API.") (p "Use this function only if you have legacy code that uses the older API.") (p "Returns " (tt "(void)") " on success; will cause an error on fail.") (pre "Example:") (pre "(readline#use-legacy-bindings)\n(current-input-port (make-gnu-readline-port))"))
(def (sig (procedure "(readline prompt1 [prompt2] )" (id readline))) (p "Reads a line using the GNU readline() function and returns a string.") (p "Both arguments must be strings; " (tt "prompt2") " is optional."))
(def (sig (procedure "(%signal-cleanup)" (id %signal-cleanup))) (p "Sets the state of the underlying readline environment to a clean slate.") (p (b "NOTE") " Calls " (tt "free()") "; so using this more than once consecutively may result in undefined behavior, as in a segfault."))
(def (sig (procedure "(clear-history)" (id clear-history))) (p "Clears the history buffer."))
(def (sig (procedure "(read-history [file])" (id read-history))) (p "Reads contents of the provided file into the history buffer.") (p "When called without file-name, reads from ~/.history.  Returns 0 on success, or errno on fail."))
(def (sig (procedure "(write-history [file])" (id write-history))) (p "Writes the history buffer to " (tt "file") " or ~/.history when no " (tt "file") " is provided.") (p "Returns " (tt "0") " on success; " (tt "errno") " on fail.") (p (b "USE AT YOUR OWN RISK!")) (p "Using this may clobber simultaneous sessions."))
(def (sig (procedure "(append-history [file])" (id append-history))) (p "Appends history buffer from the " (i "current") " session to " (tt "file") ".") (p "Returns " (tt "0") " on success; " (tt "errno") " on fail."))
(def (sig (procedure "(history-newlines)" (id history-newlines))) (p "Returns the number of entries from the " (i "current") " session."))
(def (sig (procedure "(truncate-history [file] [n])" (id truncate-history))) (p "Truncates provided history " (tt "file") " to a maximum of " (tt "n") " lines.") (p "Returns " (tt "0") " on win; " (tt "errno") " on fail."))
(def (sig (procedure "(install-history-file [homedir] [filename] [nlines])" (id install-history-file))) (p "If you also want to make the command history span sessions, add the following to your " (tt "~/.csirc") ":") (p (tt "(install-history-file)")) (p "By default this will save 1000 lines of history between sessions (it will prune the history file to 1000 lines at startup). For a different history size, pass the desired number of lines as the (optional) second argument to history-install-file-manager. If " (tt "#f") " or no second argument is passed in, no history-file-pruning will take place.") (p (b "NOTE") " Do not use this in conjunction with " (tt "rlwrap") ".  The maintainer did so and experience some very weird behavior from " (tt "csi") "."))
(def (sig (procedure "(make-readline-port [prompt] [prompt2])" (id make-readline-port))) (p "Returns an input-port that uses the GNU readline facility. If PROMPT is not given, the value returned by (repl-prompt) is used for generating the current prompt (see the Chicken manual for more details about repl-prompt). PROMPT2 is used when there are still unclosed parenthesis; if not given, an appropriate default is generated."))
(def (sig (procedure "(set-bounce-ms ms)" (id set-bounce-ms))) (p "Changes the time that the cursor spends bouncing on the matching parenthesis - the default 500ms. To turn bouncing off completely, set it to " (tt "0") "."))
(def (sig (procedure "(parse-and-bind string)" (id parse-and-bind))) (p "Passes " (tt "string") " straight to the readline library for parsing (see the readline manual page for details)."))
(def (sig (procedure "(history-list)" (id history-list))) (p "Returns the history list as a newline separated list."))
(def (sig (procedure "(history-position [pos])" (id history-position))) (p "Returns the current " (i "offset") " within the history list.") (p "Passing " (i "pos") " sets the current " (i "offset") "."))
(def (sig (procedure "(%history-add% string)" (id %history-add%))) (p "Adds " (i "string") " to the history list.") (p (b "NOTE")) (p "This function exists primarily for testing purposes.") (p "Returns " (tt "void")))
(def (sig (procedure "(%remove-history% offset)" (id %remove-history%))) (p "Removes and " (b "frees") " the specified history entry and its associated memory."))
(def (sig (procedure "(eval-last-history-line [script])" (id eval-last-history-line))) (p "The function behind " (tt ",rl-!!") ".") (p "This function is " (b "not") " added to the history unless " (i "script") " is true. DO " (b "NOT") " pass " (i "script") " as true, unless you know what you are doing: it makes it possible to accidentally cause an infinite loop if the previous command was also " (tt "eval-last-history-line #t") "!!") (p (b "NOTE")) (p "The line does not have to be from the current session. Also, I don't know what happens when there isn't said line, but I reckon it'd cause a segfault; I'll see about fixing that in the 3.1 release."))
