Return to auxdoc.c CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / emacs / src

Annotation of 43BSD/contrib/emacs/src/auxdoc.c, revision 1.1

1.1     ! root        1: /* Auxiliary documentation strings for built-in functions of GNU Emacs.
        !             2:    Copyright (C) 1985 Richard M. Stallman.
        !             3: 
        !             4: This file is part of GNU Emacs.
        !             5: 
        !             6: GNU Emacs is distributed in the hope that it will be useful,
        !             7: but WITHOUT ANY WARRANTY.  No author or distributor
        !             8: accepts responsibility to anyone for the consequences of using it
        !             9: or for whether it serves any particular purpose or works at all,
        !            10: unless he says so in writing.  Refer to the GNU Emacs General Public
        !            11: License for full details.
        !            12: 
        !            13: Everyone is granted permission to copy, modify and redistribute
        !            14: GNU Emacs, but only under the conditions described in the
        !            15: GNU Emacs General Public License.   A copy of this license is
        !            16: supposed to have been given to you along with GNU Emacs so you
        !            17: can know your rights and responsibilities.  It should be in a
        !            18: file named COPYING.  Among other things, the copyright notice
        !            19: and this notice must be preserved on all copies.  */
        !            20: 
        !            21: 
        !            22: *********
        !            23: This resembles C code for GNU Emacs but it is not.
        !            24: It is processed only by make-docfile.
        !            25: The reason these functions' doc strings are here
        !            26: is that the C preprocessor crashes on strings this long.
        !            27: So we put a 0 for the doc string in the real C source file
        !            28: and give this file to make-docfile as if it were the C source.
        !            29: *********
        !            30: 
        !            31: 
        !            32: DEFUN ("modify-syntax-entry", foo, bar, 0, 0, 0,
        !            33:   "Set syntax for character CHAR according to string S.\n\
        !            34: The syntax is changed only for table TABLE, which defaults to\n\
        !            35:  the current buffer's syntax table.\n\
        !            36: The first character of S should be one of the following:\n\
        !            37:   Space    whitespace syntax.    w   word constituent.\n\
        !            38:   _        symbol constituent.   .   punctuation.\n\
        !            39:   (        open-parenthesis.     )   close-parenthesis.\n\
        !            40:   \"        string quote.         \\   character-quote.\n\
        !            41:   $        paired delimiter.     '   expression prefix operator.\n\
        !            42:   <       comment starter.      >   comment ender.\n\
        !            43: Only single-character comment start and end sequences are represented thus.\n\
        !            44: Two-character sequences are represented as described below.\n\
        !            45: The second character of S is the matching parenthesis,\n\
        !            46:  used only if the first character is ( or ).\n\
        !            47: Any additional characters are flags.\n\
        !            48: Defined flags are the characters 1, 2, 3 and 4.\n\
        !            49:  1 means C is the start of a two-char comment start sequence.\n\
        !            50:  2 means C is the second character of such a sequence.\n\
        !            51:  3 means C is the start of a two-char comment end sequence.\n\
        !            52:  4 means C is the second character of such a sequence.")
        !            53: 
        !            54: DEFUN ("parse-partial-sexp", Ffoo, Sfoo, 0, 0, 0,
        !            55:   "Parse Lisp syntax starting at FROM until TO; return status of parse at TO.\n\
        !            56: Parsing stops at TO or when certain criteria are met;\n\
        !            57:  point is set to where parsing stops.\n\
        !            58: If fifth arg STATE is omitted or nil,\n\
        !            59:  parsing assumes that FROM is the beginning of a function.\n\
        !            60: Value is a list of six elements describing final state of parsing:\n\
        !            61:  1. depth in parens.\n\
        !            62:  2. character address of start of innermost containing list; nil if none.\n\
        !            63:  3. character address of start of last complete sexp terminated.\n\
        !            64:  4. non-nil if inside a string.\n\
        !            65:     (it is the character that will terminate the string.)\n\
        !            66:  5. t if inside a comment.\n\
        !            67:  6. t if following a quote character.\n\
        !            68: If third arg TARGETDEPTH is non-nil, parsing stops if the depth\n\
        !            69: in parentheses becomes equal to TARGETDEPTH.\n\
        !            70: Fourth arg STOPBEFORE non-nil means stop when come to\n\
        !            71:  any character that starts a sexp.\n\
        !            72: Fifth arg STATE is a six-list like what this function returns.\n\
        !            73: It is used to initialize the state of the parse.")
        !            74: 
        !            75: 
        !            76: DEFUN ("interactive", Ffoo, Sfoo, 0, 0, 0,
        !            77:  "Specify a way of parsing arguments for interactive use of a function.\n\
        !            78: For example, write\n\
        !            79:   (defun fun (arg) \"Doc string\" (interactive \"p\") ...use arg...)\n\
        !            80: to make arg be the prefix numeric argument when foo is called as a command.\n\
        !            81: This is actually a declaration rather than a function;\n\
        !            82:  it tells  call-interactively  how to read arguments\n\
        !            83:  to pass to the function.\n\
        !            84: When actually called,  interactive  just returns nil.\n\
        !            85: \n\
        !            86: The argument of  interactive  is usually a string containing a code letter\n\
        !            87:  followed by a prompt.  (Some code letters do not use I/O to get\n\
        !            88:  the argument and do not need prompts.)  To prompt for multiple arguments,\n\
        !            89:  give a code letter, its prompt, a newline, and another code letter, etc.\n\
        !            90: If the argument is not a string, it is evaluated to get a list of\n\
        !            91:  arguments to pass to the function.\n\
        !            92: Just  (interactive)  means pass no args when calling interactively.\n\
        !            93: \nCode letters available are:\n\
        !            94: a -- Function name: symbol with a function definition.\n\
        !            95: b -- Name of existing buffer.\n\
        !            96: B -- Name of buffer, possibly nonexistent.\n\
        !            97: c -- Character.\n\
        !            98: C -- Command name: symbol with interactive function definition.\n\
        !            99: d -- Value of point as number.  Does not do I/O.\n\
        !           100: D -- Directory name.\n\
        !           101: f -- Existing file name.\n\
        !           102: F -- Possibly nonexistent file name.\n\
        !           103: k -- Key sequence (string).\n\
        !           104: m -- Value of mark as number.  Does not do I/O.\n\
        !           105: n -- Number read using minibuffer.\n\
        !           106: p -- Prefix arg converted to number.  Does not do I/O.\n\
        !           107: P -- Prefix arg in raw form.  Does not do I/O.\n\
        !           108: r -- Region: point and mark as 2 numeric args, smallest first.  Does no I/O.\n\
        !           109: s -- Any string.\n\
        !           110: S -- Any symbol.\n\
        !           111: v -- Variable name: symbol that is user-variable-p.\n\
        !           112: x -- Lisp expression read but not evaluated.\n\
        !           113: X -- Lisp expression read and evaluated.\n\
        !           114: In addition, if the first character of the string is '*' then an error is\n\
        !           115:  signaled if the buffer is read-only.\n\
        !           116:  This happens before reading any arguments.")

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.