/mandos/trunk : revision 90

To get this branch, use:

bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.xml

Committer: Teddy Hogeborn
Date: 2008-08-19 13:25:14 UTC
Revision ID: teddy@fukt.bsnet.se-20080819132514-wawrvgmfjovg9poj

* Makefile (DOCBOOKTOMAN): Added "--xinclude".

* mandos-options.xml: New file; moved mandos(8) option descriptions
                      here.

* mandos.conf.xml: Add XInclude namespace.
  (OPTIONS): New separate section with options from old "DESCRIPTION"
             section.  Changed all options to include a synopsis and
             include its paragraph from "mandos-options.xml".
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Unindented
              example text.

* mandos.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OPTIONS): Moved all descriptive paragraphs to "mandos-options.xml"
             and just <xi:include/> them from here.
  (OVERVIEW): Changed to do <xi:include/>.

* overview.xml: Added DOCTYPE; reportedly needed for XInclude to work.

files added:
mandos-options.xml

files modified:
Makefile

mandos.conf.xml

mandos.xml

overview.xml

Show diffs side-by-side

added added

removed removed

mandos.xml

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

<!ENTITY VERSION "1.0">

<!ENTITY COMMANDNAME "mandos">

<!ENTITY OVERVIEW SYSTEM "overview.xml">

<title>&COMMANDNAME;</title>

154

153

<term><literal>-i</literal>, <literal>--interface <replaceable>

155

154

IF</replaceable></literal></term>

156

155

157

<para>

158

Only announce the server and listen to requests on network

159

interface <replaceable>IF</replaceable>. Default is to

160

use all available interfaces. <emphasis>Note:</emphasis>

161

a failure to bind to the specified interface is not

162

considered critical, and the server does not exit.

163

</para>

156

<xi:include href="mandos-options.xml" xpointer="interface"/>

164

157

</listitem>

165

158

</varlistentry>

166

159

168

161

<term><literal>-a</literal>, <literal>--address <replaceable>

169

162

ADDRESS</replaceable></literal></term>

170

163

171

<para>

172

If this option is used, the server will only listen to a

173

specific address. This must currently be an IPv6 address;

174

an IPv4 address can be specified using the

175

<quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.

176

Also, if a link-local address is specified, an interface

177

should be set, since a link-local address is only valid on

178

a single interface. By default, the server will listen to

179

all available addresses.

180

</para>

164

<xi:include href="mandos-options.xml" xpointer="address"/>

181

165

</listitem>

182

166

</varlistentry>

183

167

185

169

186

170

PORT</replaceable></literal></term>

187

171

188

<para>

189

If this option is used, the server to bind to that

190

port. By default, the server will listen to an arbitrary

191

port given by the operating system.

192

</para>

172

<xi:include href="mandos-options.xml" xpointer="port"/>

193

173

</listitem>

194

174

</varlistentry>

195

175

206

186

207

187

<term><literal>--debug</literal></term>

208

188

209

<para>

210

If the server is run in debug mode, it will run in the

211

foreground and print a lot of debugging information. The

212

default is <emphasis>not</emphasis> to run in debug mode.

213

</para>

189

<xi:include href="mandos-options.xml" xpointer="debug"/>

214

190

</listitem>

215

191

</varlistentry>

216

192

218

194

<term><literal>--priority <replaceable>

219

195

PRIORITY</replaceable></literal></term>

220

196

221

<para>

222

GnuTLS priority string for the TLS handshake with the

223

clients. The default is

224

<quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.

225

See <citerefentry><refentrytitle>gnutls_priority_init

226

</refentrytitle><manvolnum>3</manvolnum></citerefentry>

227

for the syntax. <emphasis>Warning</emphasis>: changing

228

this may make the TLS handshake fail, making communication

229

with clients impossible.

230

</para>

197

<xi:include href="mandos-options.xml" xpointer="priority"/>

231

198

</listitem>

232

199

</varlistentry>

233

200

235

202

<term><literal>--servicename <replaceable>NAME</replaceable>

236

203

</literal></term>

237

204

238

<para>

239

Zeroconf service name. The default is

240

<quote><literal>Mandos</literal></quote>. This only needs

241

to be changed this if it, for some reason, is necessary to

242

run more than one server on the same

243

<emphasis>host</emphasis>, which would not normally be

244

useful. If there are name collisions on the same

245

<emphasis>network</emphasis>, the newer server will

246

automatically rename itself to <quote><literal>Mandos

247

#2</literal></quote>, and so on; therefore, this option is

248

not needed in that case.

249

</para>

205

<xi:include href="mandos-options.xml"

206

xpointer="servicename"/>

250

207

</listitem>

251

208

</varlistentry>

252

209

278

235

279

236

280

237

<title>OVERVIEW</title>

281

&OVERVIEW;

238

<xi:include href="overview.xml"/>

282

239

<para>

283

240

This program is the server part. It is a normal server program

284

241

and will run in a normal system environment, not in an initial

Older »