1.1 --- a/docs/idl.1 Sun Nov 17 23:37:27 2019 +0100
1.2 +++ b/docs/idl.1 Sun Nov 17 23:37:59 2019 +0100
1.3 @@ -1,4 +1,4 @@
1.4 -.TH IDL "1" "2019-11-07" "idl 0.1" "User Commands"
1.5 +.TH IDL "1" "2019-11-17" "idl 0.1" "User Commands"
1.6 .SH NAME
1.7 idl \- L4Re IDL parser and code generator
1.8 .SH SYNOPSIS
1.9 @@ -32,8 +32,7 @@
1.10 The interface description or definition language (IDL) employed by
1.11 .B idl
1.12 is broadly similar to that used by systems such as CORBA. Indeed, a tool called
1.13 -.B dice
1.14 -was once made available for L4-based environments that sought to provide a
1.15 +DICE was once made available for L4-based environments that sought to provide a
1.16 degree of compatibility with the CORBA and DCE standards. However,
1.17 .B idl
1.18 does not seek to replicate the extensive functionality or complexity of that
1.19 @@ -215,6 +214,27 @@
1.20 .fi
1.21 .PP
1.22 Such includes are incorporated into the generated code.
1.23 +.SH SUPPORTED ATTRIBUTES
1.24 +Interfaces currently support the following attributes:
1.25 +.PP
1.26 +.TP
1.27 +protocol(\fIprotocol_value\fP)
1.28 +A protocol applying to the entire interface. Clients will specify the
1.29 +given
1.30 +.IR protocol_value
1.31 +as the message tag label when sending requests to the interface.
1.32 +.PP
1.33 +Operations currently support the following attributes:
1.34 +.PP
1.35 +.TP
1.36 +opcode\fP(\fIopcode_value\fP)
1.37 +An operation code (opcode) applying to the given operation. Without a protocol
1.38 +value applying to an interface, clients will specify the given
1.39 +.IR opcode_value
1.40 +as the message tag label when sending requests to the interface. With a
1.41 +protocol, the
1.42 +.IR opcode_value
1.43 +will be specified in the first message word.
1.44 .SH COMPONENTS AND COMPOUND INTERFACES
1.45 Components may attempt to support more than one interface. Although inheritance
1.46 might be employed to achieve this, the combination or composition of interfaces
1.47 @@ -320,6 +340,13 @@
1.48 options are used, with the generated header files being installed in a suitable
1.49 location so that the other components, when built, can locate and read these
1.50 header files.
1.51 +.PP
1.52 +Where interface headers have already been generated, the
1.53 +.BR \-h " or " \-\-headers
1.54 +options should be used (and the
1.55 +.BR \-i " and " \-\-interfaces
1.56 +options should be withheld) to avoid generating superfluous header files for
1.57 +client and server routines.
1.58 .SH AUTHOR
1.59 Paul Boddie <paul@boddie.org.uk>
1.60 .SH RESOURCES
1.61 @@ -331,4 +358,9 @@
1.62 the GNU General Public License version 2 or (at your option) a later version.
1.63 This program has absolutely no warranty.
1.64 .SH SEE ALSO
1.65 -.BR https://wiki.tudos.org/Dice_IDL_compiler
1.66 +.TP
1.67 +CORBA: https://www.omg.org/spec/CORBA/
1.68 +.TP
1.69 +DCE: http://www.opengroup.org/dce/
1.70 +.TP
1.71 +DICE: https://wiki.tudos.org/Dice_IDL_compiler