Here are described the elements implementing Texinfo definitions.
| Element | Attribute | Content | Description or Texinfo equivalence
|
| args | in-line | argument of a definition
| |
| deffn | args, block
| @deffn
| |
| cat | function category
| ||
| name | function name
| ||
| deffnx | empty | @deffnx, attributes like deffn
| |
| defun | args, block
| @defun
| |
| name | function name
| ||
| defunx | empty | @defunx, attributes like defun
| |
| defmac | args, block
| @defmac
| |
| name | macro name
| ||
| defmacx | empty | @defmacx, attributes like defmac
| |
| defspec | args, block
| @defspec
| |
| name | special form name
| ||
| defspecx | empty | @defspecx, attributes like defspec
| |
| defvr | block | @defvr
| |
| cat | variable category
| ||
| name | variable name
| ||
| defvrx | empty | @defvrx, attributes like defvr
| |
| defvar | block | @defvar
| |
| name | variable name
| ||
| defvarx | empty | @defvarx, attributes like defvar
| |
| defopt | block | @defopt
| |
| name | option name
| ||
| defoptx | empty | @defoptx, attributes like defopt
| |
| deftypefn | args, block
| @deftypefn
| |
| cat | category
| ||
| type | data type
| ||
| name | name
| ||
| deftypefnx | empty | @deftypefnx, attributes like deftypefn
| |
| deftypefun | args, block
| @deftypefun
| |
| type | data type
| ||
| name | name
| ||
| deftypefunx | empty | @deftypefunx, attributes like deftypefun
| |
| deftypevr | block | @deftypevr
| |
| cat | category
| ||
| type | data type
| ||
| name | name
| ||
| deftypevrx | empty | @deftypevrx, attributes like deftypevr
| |
| deftypevar | block | @deftypevar
| |
| data type | type
| ||
| name | name
| ||
| deftypevarx | empty | @deftypevarx, attributes like deftypevar
| |
| defcv | block | @defcv
| |
| cat | category
| ||
| class | class
| ||
| name | name
| ||
| defcvx | empty | @defcvx, attributes like defcv
| |
| defivar | block | @defivar
| |
| class | class
| ||
| name | name
| ||
| defivarx | empty | @defivarx, attributes like defivar
| |
| deftypeivar | block | @deftypeivar
| |
| class | class
| ||
| type | type
| ||
| name | name
| ||
| deftypeivarx | empty | @deftypeivarx, attributes like deftypeivar
| |
| defop | args, block
| @defop
| |
| cat | category
| ||
| class | class
| ||
| name | name
| ||
| defopx | empty | @defopx, attributes like defop
| |
| deftypeop | args, block
| @deftypeop
| |
| cat | category
| ||
| class | class
| ||
| type | type
| ||
| name | name
| ||
| deftypeopx | empty | @deftypeopx, attributes like deftypeop
| |
| defmethod | args, block
| @defmethod
| |
| class | class
| ||
| name | name
| ||
| defmethodx | empty | @defmethodx, attributes like defmethod
| |
| deftypemethod | args, block
| @deftypemethod
| |
| class | class
| ||
| type | type
| ||
| name | name
| ||
| deftypemethodx | empty | @deftypemethodx, attributes like deftypemethod
| |
| deftp | args, block
| @deftp
| |
| cat | category
| ||
| name | name
| ||
| deftpx | empty | @deftpx, attributes like deftp
|
It follows an example about the use of deffn:
<deffn cat="Command" name="sgmltexi">
<args>[<var>options</var>]... <var>sgml_source</var></args>
<p>This is the front-end for the SGML to Texinfo system.</p>
</deffn>
Here is the result:
| sgmltexi [options]... sgml_source | Command |
| This is the front-end for the SGML to Texinfo system. |