/mandos/release : revision 115

To get this branch, use:

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

« back to all changes in this revision

Viewing changes to plugin-runner.xml

Committer: Teddy Hogeborn
Date: 2008-08-29 16:53:41 UTC
Revision ID: teddy@fukt.bsnet.se-20080829165341-xzrp0xxxfrua5kzq

* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
"--interface" options.

files added:
.bzrignore

COPYING

initramfs-tools-hook

initramfs-tools-hook-conf

initramfs-tools-script

mandos-clients.conf.xml

mandos-keygen

mandos-keygen.xml

mandos-options.xml

mandos.conf.xml

mandos.xml

overview.xml

plugin-runner.xml

plugins.d/password-prompt.xml

plugins.d/password-request.xml

plugins.d/usplash

files removed:
ca.pem

cert.pem

client-cert.pem

client-key.pem

crl.pem

key.pem

files renamed:
server.py => mandos

server.conf => mandos.conf

plugbasedclient.c => plugin-runner.c

plugins.d/passprompt.c => plugins.d/password-prompt.c

plugins.d/mandosclient.c => plugins.d/password-request.c

files modified:
Makefile

TODO

clients.conf

Show diffs side-by-side

added added

removed removed

plugin-runner.xml

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

<?xml-stylesheet type="text/xsl"

href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>

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

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

<!ENTITY VERSION "1.0">

<!ENTITY COMMANDNAME "plugin-runner">

<!ENTITY TIMESTAMP "2008-08-29">

<title>Mandos Manual</title>

<productname>Mandos</productname>

<productnumber>&VERSION;</productnumber>

<date>&TIMESTAMP;</date>

<firstname>Björn</firstname>

<surname>Påhlsson</surname>

<email>belorn@fukt.bsnet.se</email>

</address>

</author>

<firstname>Teddy</firstname>

<surname>Hogeborn</surname>

<email>teddy@fukt.bsnet.se</email>

</address>

</author>

</authorgroup>

<holder>Teddy Hogeborn & Björn Påhlsson</holder>

</copyright>

<para>

This manual page is free software: you can redistribute it

and/or modify it under the terms of the GNU General Public

License as published by the Free Software Foundation,

either version 3 of the License, or (at your option) any

later version.

</para>

<para>

This manual page is distributed in the hope that it will

be useful, but WITHOUT ANY WARRANTY; without even the

implied warranty of MERCHANTABILITY or FITNESS FOR A

PARTICULAR PURPOSE. See the GNU General Public License

for more details.

</para>

<para>

You should have received a copy of the GNU General Public

License along with this program; If not, see

<ulink url="http://www.gnu.org/licenses/"/>.

</para>

</legalnotice>

</refentryinfo>

<refentrytitle>&COMMANDNAME;</refentrytitle>

<manvolnum>8mandos</manvolnum>

</refmeta>

<refname><command>&COMMANDNAME;</command></refname>

get password for encrypted rootdisk

</refpurpose>

</refnamediv>

<command>&COMMANDNAME;</command>

<arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>

<arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>

<arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>

<arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>

<arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>

<arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>

<arg choice='opt'>--debug</arg>

</cmdsynopsis>

<command>&COMMANDNAME;</command>

</cmdsynopsis>

<command>&COMMANDNAME;</command>

<arg choice='plain'>--usage</arg>

</cmdsynopsis>

<command>&COMMANDNAME;</command>

<arg choice='plain'>--version</arg>

</cmdsynopsis>

</refsynopsisdiv>

100

101

<title>DESCRIPTION</title>

102

<para>

103

<command>&COMMANDNAME;</command> is a plugin runner that waits

104

for any of its plugins to return sucessfull with a password, and

105

passes it to cryptsetup as stdout message. This command is not

106

meant to be invoked directly, but is instead meant to be run by

107

cryptsetup by being specified in /etc/crypttab as a keyscript

108

and subsequlently started in the initrd environment. See

109

<citerefentry><refentrytitle>crypttab</refentrytitle>

110

<manvolnum>5</manvolnum></citerefentry> for more information on

111

keyscripts.

112

</para>

113

114

<para>

115

plugins is looked for in the plugins directory which by default will be

116

/conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.

117

</para>

118

</refsect1>

119

120

<title>OPTIONS</title>

121

122

123

<term><literal>-g</literal>,<literal>--global-options

124

<replaceable>OPTIONS</replaceable></literal></term>

125

126

<para>

127

Global options given to all plugins as additional start

128

arguments. Options are specified with a -o flag followed

129

by a comma separated string of options.

130

</para>

131

</listitem>

132

</varlistentry>

133

134

135

<term><literal>-o</literal>,<literal> --options-for

136

<replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>

137

</literal></term>

138

139

<para>

140

Plugin specific options given to the plugin as additional

141

start arguments. Options are specified with a -o flag

142

followed by a comma separated string of options.

143

</para>

144

</listitem>

145

</varlistentry>

146

147

148

<term><literal>-d</literal>,<literal> --disable

149

<replaceable>PLUGIN</replaceable>

150

</literal></term>

151

152

<para>

153

Disable a specific plugin

154

</para>

155

</listitem>

156

</varlistentry>

157

158

159

<term><literal>--groupid <replaceable>ID</replaceable>

160

</literal></term>

161

162

<para>

163

Group ID the plugins will run as

164

</para>

165

</listitem>

166

</varlistentry>

167

168

169

<term><literal>--userid <replaceable>ID</replaceable>

170

</literal></term>

171

172

<para>

173

User ID the plugins will run as

174

</para>

175

</listitem>

176

</varlistentry>

177

178

179

<term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>

180

</literal></term>

181

182

<para>

183

Specify a different plugin directory

184

</para>

185

</listitem>

186

</varlistentry>

187

188

189

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

190

191

<para>

192

Debug mode

193

</para>

194

</listitem>

195

</varlistentry>

196

197

198

199

200

<para>

201

Gives a help message

202

</para>

203

</listitem>

204

</varlistentry>

205

206

207

<term><literal>--usage</literal></term>

208

209

<para>

210

Gives a short usage message

211

</para>

212

</listitem>

213

</varlistentry>

214

215

216

<term><literal>-V</literal>, <literal>--version</literal></term>

217

218

<para>

219

Prints the program version

220

</para>

221

</listitem>

222

</varlistentry>

223

</variablelist>

224

</refsect1>

225

226

227

<title>EXIT STATUS</title>

228

<para>

229

</para>

230

</refsect1>

231

232

233

<title>FILES</title>

234

<para>

235

</para>

236

</refsect1>

237

238

239

<title>NOTES</title>

240

<para>

241

</para>

242

</refsect1>

243

244

245

246

<para>

247

</para>

248

</refsect1>

249

250

251

<title>EXAMPLE</title>

252

<para>

253

</para>

254

</refsect1>

255

256

257

<title>SECURITY</title>

258

<para>

259

</para>

260

</refsect1>

261

262

263

264

<para>

265

<citerefentry><refentrytitle>cryptsetup</refentrytitle>

266

<manvolnum>8</manvolnum></citerefentry>,

267

<citerefentry><refentrytitle>mandos</refentrytitle>

268

<manvolnum>8</manvolnum></citerefentry>,

269

<citerefentry><refentrytitle>password-prompt</refentrytitle>

270

<manvolnum>8mandos</manvolnum></citerefentry>,

271

<citerefentry><refentrytitle>password-request</refentrytitle>

272

<manvolnum>8mandos</manvolnum></citerefentry>

273

</para>

274

</refsect1>

275

276

</refentry>

277

278

279

280

281

Older »