This is man.egg.info, produced by makeinfo version 4.7 from eggdoc-output.texi. INFO-DIR-SECTION The Algorithmic Language Scheme START-INFO-DIR-ENTRY * man.egg: (man.egg). Access the CHICKEN manual from within the REPL END-INFO-DIR-ENTRY  File: man.egg.info, Node: Top, Next: About this egg, Up: (dir) man egg ******* Access the CHICKEN manual from within the REPL Written by Mario Goulart (mailto:mario@inf.ufrgs.br) This manual corresponds to version 2.2 of the man extension library for Chicken Scheme. * Menu: * About this egg:: * Documentation:: * License:: * Index::  File: man.egg.info, Node: About this egg, Next: Documentation, Prev: Top, Up: Top 1 About this egg **************** * Menu: * Version history:: * Usage::  File: man.egg.info, Node: Version history, Next: Usage, Up: About this egg 1.1 Version history =================== `2.2' Adapted to SRFI-69 compatible hash-tables `2.1' Bug fixes and small enhancements `1.1' Added some information about the file format `1.0' Initial release  File: man.egg.info, Node: Usage, Prev: Version history, Up: About this egg 1.2 Usage ========= Load this egg like so: `(require-extension man)'  File: man.egg.info, Node: Documentation, Next: License, Prev: About this egg, Up: Top 2 Documentation *************** This extension searches and displays entries in the CHICKEN User's Manual * Menu: * Procedures:: * Creating prepared documentation from arbitrary texinfo files:: * Using man from Emacs::  File: man.egg.info, Node: Procedures, Next: Creating prepared documentation from arbitrary texinfo files, Up: Documentation 2.1 Procedures ============== -- procedure: man:load (man:load [FILENAME]) Loads a`doc' file that has been previously prepared with the`chicken-man' program. If no filename is given, it defaults to`chicken.man'. The optional argument for `man:load', a file, contains a list of items representing the documentation of an object. Each item (also a list) has the following format:`("OBJECT NAME" "PROTOTYPE" "DESCRIPTION")' Example: (("foo" "(foo FOO-ARG)" "My `foo' procedure.") ("bar" "(bar)" "This is the `bar' procedure.")) -- procedure: man:help (man:help SYMBOL) Displays the description for the string or symbol`SYMBOL'. -- procedure: man:search (man:search PATTERN) Looks up any items that match the regular expression`PATTERN' -- procedure: man:search-desc (man:search-desc PATTERN) Looks up any items whose descriptions match the regular expression`PATTERN'  File: man.egg.info, Node: Creating prepared documentation from arbitrary texinfo files, Next: Using man from Emacs, Prev: Procedures, Up: Documentation 2.2 Creating prepared documentation from arbitrary texinfo files ================================================================ You can use the `chicken-man' program to convert a `.texi' file into a document that can be searched with `man:help': $ chicken.man foo.texi $ csi -quiet #;1> (man:load "foo.doc") #;2> (man:help ...)  File: man.egg.info, Node: Using man from Emacs, Prev: Creating prepared documentation from arbitrary texinfo files, Up: Documentation 2.3 Using man from Emacs ======================== Put this code into your `.emacs' file to view the manual section for the current word (there must be a`*scheme*' buffer running somewhere): (defun chicken-help () (interactive) (let ((func (current-word))) (if func (process-send-string "*scheme*" (concat "(man:help \"" func "\")\n"))))) ;; Binds F1 to chicken-help in the scheme-mode ;; (add-hook 'scheme-mode-hook (lambda () (local-set-key [f1] 'chicken-help)))  File: man.egg.info, Node: License, Next: Index, Prev: Documentation, Up: Top 3 License ********* Copyright (c) 2005, Mario Goulart All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of the author nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  File: man.egg.info, Node: Index, Prev: License, Up: Top Index ***** [index] * Menu: * man:help: Procedures. (line 24) * man:load: Procedures. (line 7) * man:search: Procedures. (line 29) * man:search-desc: Procedures. (line 34)  Tag Table: Node: Top241 Node: About this egg590 Node: Version history754 Node: Usage1060 Node: Documentation1216 Node: Procedures1532 Node: Creating prepared documentation from arbitrary texinfo files2649 Node: Using man from Emacs3142 Node: License3760 Node: Index5349  End Tag Table