~ubuntu-branches/ubuntu/quantal/protobuf/quantal : revision 2

1

<?xml version='1.0' encoding='UTF-8'?>

2

<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"

3

"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

4

5

<!--

6

7

`xsltproc -nonet \

8

-param man.charmap.use.subset "0" \

9

-param make.year.ranges "1" \

10

-param make.single.year.ranges "1" \

11

/usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \

12

manpage.xml'

13

14

A manual page <package>.<section> will be generated. You may view the

15

manual page with: nroff -man <package>.<section> | less'. A typical entry

16

in a Makefile or Makefile.am is:

17

18

DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl

19

XP = xsltproc -nonet -param man.charmap.use.subset "0"

20

21

manpage.1: manpage.xml

22

$(XP) $(DB2MAN) $<

23

24

The xsltproc binary is found in the xsltproc package. The XSL files are in

25

docbook-xsl. A description of the parameters you can use can be found in the

26

docbook-xsl-doc-* packages. Please remember that if you create the nroff

27

version in one of the debian/rules file targets (such as build), you will need

28

to include xsltproc and docbook-xsl in your Build-Depends control field.

29

Alternatively use the xmlto command/package. That will also automatically

30

pull in xsltproc and docbook-xsl.

31

32

Notes for using docbook2x: docbook2x-man does not automatically create the

33

AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as

34

<refsect1> ... </refsect1>.

35

36

To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections

37

read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be

38

found in the docbook-xsl-doc-html package.

39

40

Validation can be done using: `xmllint -noout -valid manpage.xml`

41

42

General documentation about man-pages and man-page-formatting:

43

man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/

44

45

-->

46

47

48

<!ENTITY dhfirstname "Iustin">

49

<!ENTITY dhsurname "Pop">

50

51

<!ENTITY dhusername "&dhfirstname; &dhsurname;">

52

<!ENTITY dhemail "iusty@k1024.org">

53

<!-- SECTION should be 1-8, maybe w/ subsection other parameters are

54

allowed: see man(7), man(1) and

55

http://www.tldp.org/HOWTO/Man-Page/q2.html. -->

56

<!ENTITY dhsection "1">

57

<!-- TITLE should be something like "User commands" or similar (see

58

http://www.tldp.org/HOWTO/Man-Page/q2.html). -->

59

<!ENTITY dhtitle "protocol buffer compiler">

60

<!ENTITY dhucpackage "protobuf">

61

<!ENTITY dhpackage "protoc">

62

]>

63

64

65

66

<title>&dhtitle;</title>

67

<productname>&dhucpackage;</productname>

68

69

70

<firstname>&dhfirstname;</firstname>

71

<surname>&dhsurname;</surname>

72

<contrib>Wrote this manpage for the Debian system.</contrib>

73

74

<email>&dhemail;</email>

75

</address>

76

</author>

77

</authorgroup>

78

79

80

<holder>&dhusername;</holder>

81

</copyright>

82

83

<para>This manual page was written for the Debian system

84

(but may be used by others).</para>

85

<para>Permission is granted to copy, distribute and/or modify this

86

document under the terms of the GNU General Public License,

87

Version 2 or (at your option) any later version published by

88

the Free Software Foundation.</para>

89

<para>On Debian systems, the complete text of the GNU General Public

90

License can be found in

91

<filename>/usr/share/common-licenses/GPL</filename>.</para>

92

</legalnotice>

93

94

</refentryinfo>

95

96

<refentrytitle>&dhpackage;</refentrytitle>

97

<manvolnum>&dhsection;</manvolnum>

98

99

</refmeta>

100

101

<refname>&dhpackage;</refname>

102

<refpurpose>compile protocol buffer description files</refpurpose>

103

</refnamediv>

104

105

106

<command>&dhpackage;</command>

107

108

109

110

<arg choice="opt"><option>--python_out=<replaceable>OUT_DIR</replaceable></option></arg>

111

112

113

114

115

<arg choice="plain"><option>--proto-path=<replaceable>PATH</replaceable></option></arg>

116

</group>

117

</arg>

118

<arg choice="plain"><replaceable>PROTO_FILE</replaceable></arg>

119

</cmdsynopsis>

120

<!-- Normally the help and version options make the programs stop

121

right after outputting the requested information. -->

122

123

<command>&dhpackage;</command>

124

125

126

127

</group>

128

</cmdsynopsis>

129

130

<command>&dhpackage;</command>

131

<arg choice="plain"><option>--version</option></arg>

132

</cmdsynopsis>

133

</refsynopsisdiv>

134

135

<title>DESCRIPTION</title>

136

137

<para><command>&dhpackage;</command> is a compiler for protocol

138

buffers definitions files. It can can generate C++, Java and

139

Python source code for the classes defined in

140

<replaceable>PROTO_FILE</replaceable>.</para>

141

142

</refsect1>

143

144

145

<title>OPTIONS</title>

146

147

<!-- Use the variablelist.term.separator and the

148

variablelist.term.break.after parameters to

149

control the term elements. -->

150

151

152

<term><option>--proto_path=<replaceable>PATH</replaceable></option></term>

153

154

<para>Specify the directory in which to search for imports.

155

May be specified multiple times; directories will be

156

searched in order. If not given, the current working

157

directory is used.</para>

158

</listitem>

159

</varlistentry>

160

161

162

163

<simpara>Enable generation of C++ bindings and store them in

164

165

</listitem>

166

</varlistentry>

167

168

169

170

<simpara>Enable generation of Java bindings and store them

171

in <replaceable>OUT_DIR</replaceable>.</simpara>

172

</listitem>

173

</varlistentry>

174

175

<term><option>--python_out=<replaceable>OUT_DIR</replaceable></option></term>

176

177

<simpara>Enable generation of Python bindings and store them

178

in <replaceable>OUT_DIR</replaceable>.</simpara>

179

</listitem>

180

</varlistentry>

181

182

183

184

185

<para>Show summary of options.</para>

186

</listitem>

187

</varlistentry>

188

189

<term><option>--version</option></term>

190

191

<para>Show version of program.</para>

192

</listitem>

193

</varlistentry>

194

</variablelist>

195

196

<para>Note that at least one of the <option>--cpp_out</option>,

197

<option>--java_out</option> and <option>--python_out</option>

198

options must be given (otherwise the program has nothing to

199

do). It's also possible to specify more than one.</para>

200

201

</refsect1>

202

203

204

205

206

<para>The program currently exits with code 255 for all errors,

207

which makes it hard to differentiante from scripts the actual

208

error.</para>

209

210

<para>The upstreams <acronym>BTS</acronym> can be found at <ulink

211

url="http://code.google.com/p/protobuf/issues/list"/>.</para>

212

213

</refsect1>

214

215

216

217

<para>More documentation about protocol buffers syntax and APIs is

218

available online at <ulink

219

url="http://code.google.com/apis/protocolbuffers/docs/overview.html"></ulink>.</para>

220

221

222

</refsect1>

223

</refentry>