summaryrefslogtreecommitdiff
path: root/doc/ref/scheme-using.texi
AgeCommit message (Collapse)AuthorFilesLines
2013-03-10add %site-ccache-dirJason Earl1-5/+6
* libguile/load.h: * libguile/load.c (scm_sys_site_ccache_dir): New procedure. * doc/ref/scheme-using.texi (Installing Site Packages): * doc/ref/api-options.texi (Build Config): Add docs. Fixes bug 10326.
2013-03-10excise use of "iff" in the manualJason Earl1-1/+1
* doc/ref/api-compound.texi: * doc/ref/api-control.texi: * doc/ref/api-data.texi: * doc/ref/api-macros.texi: * doc/ref/api-modules.texi: * doc/ref/api-procedures.texi: * doc/ref/api-scheduling.texi: * doc/ref/api-smobs.texi: * doc/ref/api-undocumented.texi: * doc/ref/api-utility.texi: * doc/ref/compiler.texi: * doc/ref/intro.texi: * doc/ref/scheme-using.texi: * doc/ref/sxml.texi: * doc/ref/web.texi: Change uses of "iff" to "if, otherwise". Fixes bug 10302.
2013-03-07,option evaluates its right-hand-sideAndy Wingo1-2/+5
* doc/ref/scheme-using.texi (System Commands): Better documentation for ,option. * module/system/repl/command.scm (option): Evaluate the RHS when setting an option. Fixes bug 13076.
2013-01-16trace: limit length of "| | | "... prefixAndy Wingo1-2/+7
* module/system/vm/trace.scm (build-prefix): New helper. (print-application, print-return): Use the helper. (trace-calls-to-procedure, trace-calls-in-procedure): (trace-instructions-in-procedure, call-with-trace): Add #:max-indent argument, defaulting to the terminal width less 40 characters. * doc/ref/scheme-using.texi: Update `trace' docs. Based on a patch by Nala Ginrut.
2012-12-10repl: add repl-option for customized printDaniel Hartwig1-0/+4
Closes <http://bugs.gnu.org/13077>. * module/system/repl/common.scm (repl-default-options) (repl-print): Add option to use customized print procedure. * doc/ref/scheme-using.texi (REPL Commands): Update.
2012-10-18Fix typo in scheme-using.texiIan Price1-1/+1
* doc/ref/scheme-using.texi (System Commands): Fix typo.
2012-02-04Make notation for Scheme repeated arguments more consistent in manual.Bake Timmons1-2/+2
* doc/ref/api-compound.texi * doc/ref/api-control.texi * doc/ref/api-data.texi * doc/ref/api-debug.texi * doc/ref/api-evaluation.texi * doc/ref/api-macros.texi * doc/ref/api-memory.texi * doc/ref/api-modules.texi * doc/ref/api-procedures.texi * doc/ref/api-regex.texi * doc/ref/api-scheduling.texi * doc/ref/api-utility.texi * doc/ref/goops.texi * doc/ref/match.texi * doc/ref/misc-modules.texi * doc/ref/posix.texi * doc/ref/r6rs.texi * doc/ref/scheme-using.texi * doc/ref/srfi-modules.texi * doc/ref/sxml-match.texi: Make notation for Scheme repeated arguments more consistent in manual.
2012-02-02Make consistent the usage of variable names in the function definitions ↵Bake Timmons1-3/+3
found in the Texinfo docs. * doc/r5rs/r5rs.texi: * doc/ref/api-compound.texi: * doc/ref/api-data.texi: * doc/ref/api-debug.texi: * doc/ref/api-evaluation.texi: * doc/ref/api-io.texi: * doc/ref/api-modules.texi: * doc/ref/api-procedures.texi: * doc/ref/api-scheduling.texi: * doc/ref/api-smobs.texi: * doc/ref/compiler.texi: * doc/ref/misc-modules.texi: * doc/ref/posix.texi: * doc/ref/scheme-using.texi: * doc/ref/srfi-modules.texi: * doc/ref/vm.texi: * doc/ref/web.texi: * doc/sources/env.texi: Make usage of variable names of function definitions more consistent.
2012-01-27more documentation on the process of loading source and compiled filesAndy Wingo1-2/+3
* doc/ref/api-evaluation.texi (Load Paths): Move documentation of %load-path and related procedures here, from Build Config. Add docs for %load-compiled-path. * doc/ref/api-foreign.texi: * doc/ref/api-modules.texi: * doc/ref/api-options.texi: * doc/ref/scheme-using.texi: Update xrefs.
2012-01-21add current-filename, add-to-path, add-to-load-pathAndy Wingo1-2/+2
* module/ice-9/boot-9.scm (current-filename, add-to-path) (add-to-load-path): New syntaxen. * doc/ref/api-evaluation.texi (Loading): Move load-path related procedures to a new section: (Load Paths): Hither. Document add-to-path and add-to-load-path. * doc/ref/api-debug.texi (Source Properties): Document current-source-location and current-filename. * doc/ref/api-modules.texi: * doc/ref/guile-invoke.texi: * doc/ref/scheme-using.texi: Update @ref for Load Paths change.
2011-10-12add "Installing Site Packages"Andy Wingo1-0/+58
* doc/ref/scheme-using.texi (Installing Site Packages): Add a new section about where to install .scm, .go, and .so files. * doc/ref/tour.texi: Reference it here. * doc/ref/guile.texi: Add new section.
2011-10-10add ,expand and ,optimizeAndy Wingo1-0/+8
* module/system/repl/command.scm (*command-table*, expand, optimize): New meta-commands. * module/system/repl/common.scm (repl-expand, repl-optimize): New helpers. * doc/ref/scheme-using.texi (Compile Commands): Document.
2011-07-23doc: Remove redundant footnote about the former name of `guild'.Ludovic Courtès1-5/+3
* doc/ref/scheme-using.texi (Using Guile Tools): Remove redundant footnote introduced in e108c961fed2ffdedddcd10bad9c6aae44491b1e. Mention the version where the new name was introduced.
2011-06-08doc: Mention the former name of `guild'.Ludovic Courtès1-1/+4
* doc/ref/scheme-using.texi (Using Guile Tools): Add a footnote mentioning that `guild' used to be `guile-tools'. * doc/ref/tools.texi (Executable Modules): Nitpicks.
2011-05-31add guild docsAndy Wingo1-0/+28
* doc/ref/scheme-using.texi (Using Guile Tools): Add some optimistic guild docs.
2011-03-29document -q, repl optionsAndy Wingo1-5/+49
* doc/ref/scheme-scripts.texi (Invoking Guile): Document -q. * doc/ref/scheme-using.texi (Init File): New section, on .guile. (Readline): Link to Init File. (System Commands): Document the various REPL options, and repl-default-option-set!.
2011-03-04Add ,width meta-command to set screen width in debug outputMichael Gran1-0/+6
This meta-command allows one to set the default number of columns that output from ,backtrace and ,locals shall occupy. * doc/ref/scheme-using.texi (Debug Commands): document ,width * module/system/repl/command.scm (*width*): new var (backtrace, locals): use *width* in optarg (width): new meta-command
2010-12-17add ,reload meta-command and document it and reload-moduleAndy Wingo1-0/+4
* module/ice-9/boot-9.scm (reload-module): Add docstring. * module/system/repl/command.scm (reload): New meta-command. * doc/ref/scheme-using.texi (Module Commands): Document the ,reload meta-command. * doc/ref/api-modules.texi (Module System Reflection): Document reload-module.
2010-11-20Allow user-defined meta-commandsAndreas Rottmann1-0/+7
Besides allowing user-defined meta-commands, this change also refactors the meta-command machinery to split reading a command's arguments from the procedure actually implementing it, and hence allows nesting meta-commands. As an example of such a command, ",in" is added as a new meta-command. * module/system/repl/command.scm: Export `define-meta-command'. (*command-module*): Replaced by the hash table `*command-infos*'. (command-info, make-command-info, command-info-procedure) (command-info-arguments-reader): New procedures, encapsulating the information about a meta-command. (command-procedure): Adapted to use the `command-info' lookup procedure. (read-command-arguments): New auxiliary procedure invoking a command's argument reader procedure. (meta-command): Adapted to the split of reading arguments and executing a command. (add-meta-command!): New auxiliary procedure, registers a meta command's procedure and argument reader into `*command-infos* and `*command-table*. (define-meta-command): Extended to allow specification of the command's category; split the argument reader and actual command procedure. (guile:apropos, guile:load, guile:compile-file, guile:gc): Remove these aliases, they are unnecessary as we now use a hash table instead of the module to store the commands. (in): New meta-command, which evaluates an expression, or alternatively executes another meta-command, in the context of a specific module. * doc/ref/scheme-using.texi (Module Commands): Document the `in' meta-command. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2010-10-12Add TeX form of jao's nameNeil Jerram1-1/+8
* doc/ref/scheme-using.texi: Add TeX equivalent for José.
2010-10-12remove gds docs, telling users instead to use geiser and pareditAndy Wingo1-714/+43
* doc/ref/scheme-using.texi (Using Guile in Emacs): Remove GDS docs, as we don't have GDS any more. Instead of surveying the field, be opinionated and tell users what to use: Geiser and Paredit.
2010-10-12minor doc fixupsAndy Wingo1-10/+11
* doc/ref/scheme-scripts.texi (Invoking Guile): Some typos. * doc/ref/tour.texi (Running Guile Scripts): More typos and PDF improvements. * doc/ref/scheme-using.texi (Readline, Value History): Minor rewording. (Help Commands): Minor fixup.
2010-10-08add repl debugging command docsAndy Wingo1-45/+42
* doc/ref/scheme-using.texi (Debug Commands): Add docs for new debugging commands (break, step, registers, etc).
2010-10-07update traps documentation (unfinished)Andy Wingo1-7/+5
* doc/ref/Makefile.am: * doc/ref/guile.texi: * doc/ref/scheme-debugging.texi: Remove scheme-debugging.texi, which only described tracing. Tracing documentation is now in api-debugging. * doc/ref/scheme-using.texi (Evaluating Scheme Code): Remove reference to source traps, as that section is going away. * doc/ref/api-modules.texi (Included Guile Modules): Remove reference to Tracing. This section is a little silly, anyway... * doc/ref/api-evaluation.texi (VM Behaviour): Remove section, it is in api-debugging now. * doc/ref/api-debug.texi (Stacks, Frames): Rename sections from "Examining the Stack" and "Examining Stack Frames", respectively. (Traps): Update for current API. A big and not-quite-finished update.
2010-08-31Add new debug meta-command ,error-messageJose A. Ortega Ruiz1-0/+8
* module/system/repl/error-handling.scm: use the error string to construct the <debug> instance. * module/system/repl/command.scm: new debug command `error-message' that extracts the new <debug> field, available to stack commands as `message'. * doc/ref/scheme-using.texi: documentation for new command. * module/system/repl/debug.scm: <debug> stores the error string in a new field.
2010-08-06only one Value History sectionAndy Wingo1-2/+2
* doc/ref/repl-modules.texi: Remove section on Value History, it's covered in scheme-using. * doc/ref/scheme-using.texi: Rename "Value Historyx" section to "Value History". * doc/ref/guile.texi: Update xref.
2010-07-16update debugger docsAndy Wingo1-205/+368
* doc/ref/api-debug.texi (Debug on Error): Update xref. * doc/ref/scheme-using.texi (REPL Commands): New subsection. (Interactive Debugging): Rename from Interactive Debugger, to indicate that debugging is just part of the REPL. Update docs.
2010-07-10update manual for value history on by defaultAndy Wingo1-9/+43
* doc/ref/compiler.texi: Update for new ,pp meta-command. * doc/ref/scheme-using.texi (Using Guile Interactively): Show value history in examples. (Value Historyx): Update docs to mention the repl option and the programmatic interface.
2010-06-02some repl doc updatesAndy Wingo1-12/+17
* doc/ref/tour.texi (Reporting Bugs): Update instructions for generating a backtrace. * doc/ref/scheme-using.texi: Update examples of Guile prompts, and add an explanation of the prompt format.
2009-12-17replace ascii figures with scalable ps/pdf versions.Brian Gough1-28/+12
use ascii figures in HTML output, to work around deficiency in makeinfo where images are not copied to target directory.
2008-12-10Remove everything to do with GDS BreakpointsNeil Jerram1-167/+21
(which I now regard as an unsuccesful experiment) This commit makes all affected files the same in master as they are in branch_release-1-8. * doc/ref/api-debug.texi (Breakpoints): Removed. * doc/ref/scheme-using.texi (GDS Introduction, GDS Getting Started, Displaying the Scheme Stack): Remove mentions of breakpoints. (Setting Specific Breakpoints, Setting GDS-managed Breakpoints, Setting and Managing Breakpoints, Listing and Deleting Breakpoints, Moving and Losing Breakpoints): Removed. * emacs/gds-scheme.el (gds-bufferless-breakpoints, gds-bpdef:behaviour, gds-bpdef:type, gds-bpdef:file-name, gds-bpdef:proc-name, gds-bpdef:lc, gds-breakpoint-number, gds-breakpoint-buffers, gds-breakpoint-programming, gds-breakpoint-cache, gds-breakpoint-face, gds-breakpoints-file-name, gds-delete-lost-breakpoints, gds-bpdefs-cache, gds-read-breakpoints-file, gds-adopt-breakpoints, gds-adopt-breakpoint, gds-make-breakpoint-overlay, gds-send-breakpoint-to-client, gds-default-breakpoint-type, gds-set-breakpoint, gds-defun-name-region, gds-breakpoint-overlays-at, gds-write-breakpoints-file, gds-fold-breakpoints, gds-delete-breakpoints, gds-delete-breakpoint, gds-breakpoint-at-point, gds-union, gds-user-selected-breakpoint, gds-describe-breakpoints, gds-describe-breakpoint, gds-after-save-update-breakpoints, gds-breakpoint-map): Removed. (gds-nondebug-protocol): Removed handling for `breakpoint' and `get-breakpoints'. * emacs/gds.el (gds-scheme-first-load): Removed. * ice-9/debugging/Makefile.am (ice9_debugging_sources): Removed breakpoints.scm and load-hooks.scm. * ice-9/debugging/breakpoints.scm: Removed. * ice-9/debugging/load-hooks.scm: Removed. * ice-9/gds-client.scm (handle-nondebug-protocol): Remove everything to do with breakpoints. (breakpoints, set-gds-breakpoints): Removed. (run-utility): Call `connect-to-gds' instead of `set-gds-breakpoints'.
2008-07-17Single stepping through code from EmacsNeil Jerram1-0/+8
When you use GDS to evaluate Scheme code from Emacs, you can now use `C-u' to indicate that you want to single step through that code. See `Evaluating Scheme Code' in the manual for more details. * scheme-using.texi (Evaluating Scheme Code): Document use of `C-u' prefix with evaluation commands. * gds-scheme.el (gds-eval-region, gds-eval-expression) (gds-eval-defun, gds-eval-last-sexp): Support `C-u' prefix, meaning that user wants to single step through the code. * gds-client.scm (handle-nondebug-protocol): Add support for setting a trap on code that is about to be evaluated.
2008-05-05Add NEWS and concept index entries for traps infrastructure and Emacs support.Neil Jerram1-0/+2
2008-03-19* api-debug.texi (Low Level Trap Calls): Removed (materialNeil Jerram1-101/+65
duplicated elsewhere); doc for with-traps and debug-object? moved to section on evaluator trap options. (High Level Traps): Renamed just `Traps'. Add references to evaluator trap options and debug options. Make language appropriate for core Guile (as opposed to previously separate package). (Location Traps): Corrected to reflect that location traps now specify a specific position, not a range of positions. (Debugging Examples): New (content moved here from scheme-debugging.texi, and updated to use traps instead of breakpoints). * api-modules.texi (Included Guile Modules): Change `Debugging Features' reference to `Tracing'. * api-options.texi (Evaluator trap options): Doc for with-traps and debug-object? is now here. * guile.texi, scheme-debugging.texi: Move the `Tracing' content of scheme-debugging.texi to the Modules section. * scheme-using.texi (Using Guile in Emacs, GDS Getting Started): Minor edits. * scheme-debugging.texi (Debugging Features, Intro to Breakpoints): Removed. (Examples): Moved to api-debug.texi. (Tracing, Old Tracing): Promoted one level. (New Tracing, Tracing Compared): Removed.
2006-10-10(Setting and Managing Breakpoints): New textNeil Jerram1-23/+51
about what happens when a breakpoint is created. (Listing and Deleting Breakpoints, Moving and Losing Breakpoints): New.
2006-10-08(GDS Getting Started): Editorial updates.Neil Jerram1-7/+8
2006-10-08(Working with GDS in Scheme Buffers): NewNeil Jerram1-9/+20
subsection, to group (Access to Guile Help and Completion, Setting and Managing Breakpoints, Evaluating Scheme Code) together.
2006-10-06(Access to Guile Help and Completion): Mention where keys areNeil Jerram1-16/+34
defined. (Setting and Managing Breakpoints): Update text on how to set breakpoints.
2006-10-05(Using Guile in Emacs): Subnodes reordered,Neil Jerram1-114/+114
from (Displaying the Scheme Stack, Continuing Execution, Evaluating Scheme Code, Setting and Managing Breakpoints, Access to Guile Help and Completion) to (Access to Guile Help and Completion, Setting and Managing Breakpoints, Evaluating Scheme Code, Displaying the Scheme Stack, Continuing Execution).
2006-10-03(GDS Getting Started): Editorial updates.Neil Jerram1-31/+71
2006-09-28(GDS Introduction, GDS Getting Started): MinorNeil Jerram1-6/+5
edits.
2006-09-26(Using Guile in Emacs, GDS Introduction):Neil Jerram1-251/+175
Editorial updates. (GDS Architecture): Moved earlier in containing section; editorial updates. (GDS Getting Started, How to Use GDS): Merged; editorial updates; subsections reordered.
2006-09-25* scheme-using.texi (Error Handling, Interactive Debugger): MinorNeil Jerram1-60/+58
editorial improvements. (Leave Debugger): Removed. (Display Backtrace): Minor updates. (Frame Selection, Frame Information, Frame Evaluation) : Minor editorial improvements. (Stepping and Continuing): Merged from three previous nodes; plus minor improvements. Removed doc for `trace-finish', which no longer exists. * debugging/ice-9-debugger-extensions.scm (debugger:step): Docstring improvements. (debugger:next): Docstring improvements. (debugger:continue): Docstring improvements. * debugger/commands.scm (up, down): Docstring corrections. (info-args, info-frame, position, evaluate): Docstring improvements.
2006-08-23(Using Guile in Emacs): New text aboutNeil Jerram1-53/+137
available Emacs libraries. (GDS Introduction): New node, containing GDS-specific introductory text.
2006-08-18(Using Guile in Emacs): Unignore extra GDSNeil Jerram1-2/+0
intro text. (I will edit this down later. For now it's convenient to have it all appearing, so it's visible on paper.)
2006-08-11* scheme-using.texi (Run To Frame Exit): Improved doc for finish.Neil Jerram1-5/+778
(Continue Execution): Improved doc for continue. (Using Guile in Emacs): Lots of new docs about the Emacs interface. * api-debug.texi (Low Level Trap Calls): New. (Using Traps): Removed, material incorporated into Low Level Trap Calls. (High Level Traps): New. (Breakpoints): New. * scheme-using.texi (Single Stepping): Improve doc for step and next. * api-debug.texi (Debug on Error): Note need to handling of errors in C.
2006-08-01* scheme-debugging.texi (Debug Last Error, Interactive Debugger):Neil Jerram1-0/+411
Moved/merged to scheme-using.texi, as REPL features. (Examples): New. (Intro to Breakpoints): New introductory text here. Removed all subnodes except for Breakpoints Overview. * scheme-using.texi: New. * guile.texi (Programming in Scheme): Include new scheme-using.texi file. * Makefile.am (guile_TEXINFOS): Include new scheme-using.texi file.