From fce38d77ec95261ec7ae3694d0b5db91f1cb39c2 Mon Sep 17 00:00:00 2001 From: Anders Svensson Date: Sat, 30 Nov 2013 20:02:12 +0100 Subject: Generate diameterc.1, not diameter_compile.1 --- lib/diameter/doc/src/diameter_compile.xml | 149 ------------------------------ lib/diameter/doc/src/diameterc.xml | 149 ++++++++++++++++++++++++++++++ lib/diameter/doc/src/files.mk | 2 +- lib/diameter/doc/src/ref_man.xml | 4 +- 4 files changed, 152 insertions(+), 152 deletions(-) delete mode 100644 lib/diameter/doc/src/diameter_compile.xml create mode 100644 lib/diameter/doc/src/diameterc.xml (limited to 'lib/diameter/doc/src') diff --git a/lib/diameter/doc/src/diameter_compile.xml b/lib/diameter/doc/src/diameter_compile.xml deleted file mode 100644 index 820bde6986..0000000000 --- a/lib/diameter/doc/src/diameter_compile.xml +++ /dev/null @@ -1,149 +0,0 @@ - -dictionary file'> - - - %also; - %here; -]> - - -
- -20112013 -Ericsson AB. All Rights Reserved. - - - -The program may be used and/or copied only with the written permission -from Ericsson AB, or in accordance with the terms and conditions -stipulated in the agreement/contract under which the program has been -supplied. - - - -diameterc(1) - - - - - -diameter_compile.xml -
- -diameterc -] ]]> - - - -

-The diameterc utility is used to compile a diameter -&dictionary; into Erlang source. -The resulting source implements the interface diameter required -to encode and decode the dictionary's messages and AVPs.

- -

-The module &man_make; provides an alternate compilation interface.

- - - -
-USAGE - - - -] ]]> - -

-Compile a single dictionary file to Erlang source. -Valid options are as follows.

- - -]]> - -

-Prepend the specified directory to the code path. -Use to point at beam files compiled from inherited dictionaries, -&dict_inherits; in a dictionary file creating a beam -dependency, not an erl/hrl dependency.

- -

-Multiple -i options can be specified.

- - -]]> - -

-Write generated source to the specified directory. -Defaults to the current working directory.

- - - - - -

-Suppress erl and hrl generation, respectively.

- - -]]> -]]> - -

-Transform the input dictionary before compilation, setting -&dict_name; or &dict_prefix; to the specified -string.

- - -]]> - -

-Transform the input dictionary before compilation, appending -&dict_inherits; of the specified string.

- -

-Two forms of --inherits have special meaning:

- -
---inherits -
---inherits Prev/Mod
-
- -

-The first has the effect of clearing any previous inherits, the second -of replacing a previous inherits of Prev to one of Mod. -This allows the semantics of the input dictionary to be changed without -modifying the file itself.

- -

-Multiple --inherits options can be specified.

- - - - - - - -
- - - -
-EXIT STATUS - -

-Returns 0 on success, non-zero on failure.

- -
- - - -
-SEE ALSO - -

-&man_make;, &man_dict;

- -
- - diff --git a/lib/diameter/doc/src/diameterc.xml b/lib/diameter/doc/src/diameterc.xml new file mode 100644 index 0000000000..039f4f9cdd --- /dev/null +++ b/lib/diameter/doc/src/diameterc.xml @@ -0,0 +1,149 @@ + +dictionary file'> + + + %also; + %here; +]> + + +
+ +20112013 +Ericsson AB. All Rights Reserved. + + + +The program may be used and/or copied only with the written permission +from Ericsson AB, or in accordance with the terms and conditions +stipulated in the agreement/contract under which the program has been +supplied. + + + +diameterc(1) + + + + + +diameterc.xml +
+ +diameterc +] ]]> + + + +

+The diameterc utility is used to compile a diameter +&dictionary; into Erlang source. +The resulting source implements the interface diameter required +to encode and decode the dictionary's messages and AVPs.

+ +

+The module &man_make; provides an alternate compilation interface.

+ + + +
+USAGE + + + +] ]]> + +

+Compile a single dictionary file to Erlang source. +Valid options are as follows.

+ + +]]> + +

+Prepend the specified directory to the code path. +Use to point at beam files compiled from inherited dictionaries, +&dict_inherits; in a dictionary file creating a beam +dependency, not an erl/hrl dependency.

+ +

+Multiple -i options can be specified.

+ + +]]> + +

+Write generated source to the specified directory. +Defaults to the current working directory.

+ + + + + +

+Suppress erl and hrl generation, respectively.

+ + +]]> +]]> + +

+Transform the input dictionary before compilation, setting +&dict_name; or &dict_prefix; to the specified +string.

+ + +]]> + +

+Transform the input dictionary before compilation, appending +&dict_inherits; of the specified string.

+ +

+Two forms of --inherits have special meaning:

+ +
+--inherits -
+--inherits Prev/Mod
+
+ +

+The first has the effect of clearing any previous inherits, the second +of replacing a previous inherits of Prev to one of Mod. +This allows the semantics of the input dictionary to be changed without +modifying the file itself.

+ +

+Multiple --inherits options can be specified.

+ + + + + + + +
+ + + +
+EXIT STATUS + +

+Returns 0 on success, non-zero on failure.

+ +
+ + + +
+SEE ALSO + +

+&man_make;, &man_dict;

+ +
+ + diff --git a/lib/diameter/doc/src/files.mk b/lib/diameter/doc/src/files.mk index 510786a7fb..6e8b1f9068 100644 --- a/lib/diameter/doc/src/files.mk +++ b/lib/diameter/doc/src/files.mk @@ -21,7 +21,7 @@ XML_APPLICATION_FILES = \ ref_man.xml XML_REF1_FILES = \ - diameter_compile.xml + diameterc.xml XML_REF3_FILES = \ diameter.xml \ diff --git a/lib/diameter/doc/src/ref_man.xml b/lib/diameter/doc/src/ref_man.xml index 4b99fe716d..1095887144 100644 --- a/lib/diameter/doc/src/ref_man.xml +++ b/lib/diameter/doc/src/ref_man.xml @@ -6,7 +6,7 @@
2011 -2012 +2013 Ericsson AB. All Rights Reserved. @@ -39,7 +39,7 @@ applications on top of the Diameter protocol.

- + -- cgit v1.2.3