Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

radadrdoc (1)

Name

radadrdoc - Documentation generator

Synopsis

/usr/bin/radadrdoc [-h] -o {adr, docbook, docbook-man, man, html,
rmdoc, spec-odoc}
adr

Description

radadrdoc(1)                     User Commands                    radadrdoc(1)



NAME
       radadrdoc - Documentation generator

SYNOPSIS
       /usr/bin/radadrdoc [-h] -o {adr, docbook, docbook-man, man, html,
        rmdoc, spec-odoc}
        adr

DESCRIPTION
       The radadrdoc command is the ADR IDL documentation processing tool. Its
       primary purpose is to generate documentation for ADR specifications.


       All invocations validate the given adr against the ADR schema.

OPTIONS
       The following options are supported:

       -o format    Generates documentation in the given format for the inter-
                    face  definition in the adr. Documentation can be improved
                    by decorating the various parts of the  interface  defini-
                    tion  with summary and doc elements. The following formats
                    are supported:


                    adr

                        ADR IDL format expanded for documentation processing.


                    docbook

                        Standard DocBook format (article), a precursor to doc-
                        book-html format.


                    docbook-man

                        Man  page  content in a DocBook format, a precursor to
                        man format.


                    html

                        HTML content produced by transformation  from  DocBook
                        article format.


                    man

                        A man page in [nt]roff format.


                    rmdoc

                        adr, with the summary and doc elements removed.


                    spec-odoc

                        bundlespec  file  for  odoctool. For more information,
                        see the odoctool(1) man page.


                    -h, --help

                        Display the help message and exit.


                    -o {adr,                                     docbook, doc-
                    book-man,                                     man, html,
                    rmdoc, spec-odoc}
                    --output-format {adr,
                    docbook, docbook-man,
                    man, html,                                     rmdoc,
                    spec-odoc}

                        Output format.




OPERANDS
       The following operands are supported:

       adr    The  path  to the API specification for which type and interface
              definitions must be generated.


EXAMPLES
       Example 1 Generating a Manual Page



       The following command generates a manual page describing the  C  client
       documentation for the API defined in myapi.adr:


         $ radadrdoc -o man myapi.adr > myapi-1.3rad



FILES
       /usr/share/lib/xml/rng/radadr.rng.1

           The core ADR RelaxNG schema definition.


       /usr/share/lib/xml/rng/radadr-doc.rng.1

           The ADR RelaxNG schema definition for documentation elements.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +-----------------------------+--------------------------------+
       |                             |                                |
       |                             |                                |
       |ATTRIBUTE TYPE               |ATTRIBUTE VALUE                 |
       +-----------------------------+--------------------------------+
       |Availability                 |system/management/rad/radadrgen |
       +-----------------------------+--------------------------------+
       |Interface Stability          |Private                         |
       +-----------------------------+--------------------------------+

SEE ALSO
       attributes(7), rad(8), odoctool(1)



Oracle Solaris 11.4               27 Nov 2017                     radadrdoc(1)