~ubuntu-branches/ubuntu/utopic/libconfig-model-openssh-perl/utopic-proposed

Viewing changes to lib/Config/Model/models/Ssh/HostElement.pod

Committer: Package Import Robot
Author(s): Dominique Dumont, Salvatore Bonaccorso, Dominique Dumont
Date: 2013-05-04 21:11:02 UTC
mfrom: (1.1.19)
Revision ID: package-import@ubuntu.com-20130504211102-l2oiug4e6peqptte

Tags: 1.227-1

[ Salvatore Bonaccorso ]
* Change Vcs-Git to canonical URI (git://anonscm.debian.org)
* Change search.cpan.org based URIs to metacpan.org based URIs

[ Dominique Dumont ]
* Imported Upstream version 1.227:
  * Removed Augeas backend (no longer needed, comments are handled
    by Config::Model::Backend::OpenSsh)
  * Replaced Any::Moose with Mouse.
* control:
  * updated std-version
  * added enhances openssh-client openssh-server
  * updated description
  * depends on libmouse-perl instead of libany-moose-perl
  * depends on libconfig-model-perl ( >= 2.034)
* copyright: updated years

Show diffs side-by-side

added added

removed removed

lib/Config/Model/models/Ssh/HostElement.pod

Specify the path to the control socket used for connection sharing as described in the ControlMaster section above or the string 'none' to disable connection sharing. In the path, '%l' will be substituted by the local host name, '%h' will be substituted by the target host name, '%p' the port, and '%r' by the remotelogin username. It is recommended that any ControlPath used for opportunistic connection sharing include at least %h, %p, and %r. This ensures that shared connections are uniquely identified.

I<< Optional. Type uniline. >>

=head2 ControlPersist - persists the master connection in the background

When used in conjunction with ControlMaster, specifies that the master connection should remain open in the background (waiting for future client connections) after the initial client connection has been closed. If set to ``no'', then the master connection will not be placed into the background, and will close as soon as the initial client connection is closed. If set to ``yes'', then the master connection will remain in the background indef- initely (until killed or closed via a mechanism such as the ssh(1) ``-O exit'' option). If set to a time in seconds, or a time in any of the formats documented in sshd_config(5), then the backgrounded master connection will automatically terminate after it has remained idle (with no client connections) for the specified time.I<< Optional. Type uniline. >>

=head2 DynamicForward

Specifies that a TCP port on the local machine be forwarded over the secure channel, and the application protocol is then used to determine where to connect to from the remote machine.

255

259

256

260

If the bind_address is not specified, the default is to only bind to loopback addresses. If the bind_address is '*' or an empty string, then the forwarding is requested to listen on all inter faces. Specifying a remote bind_address will only succeed if the server's GatewayPorts option is enabled (see sshd_config(5)).I<< Optional. Type list of node. >>

257

261

262

=head2 RequestTTY

263

264

Specifies whether to request a pseudo-tty for the session. This option mirrors the -t and -T flags for C<ssh>.I<< Optional. Type enum. choice: 'yes', 'no', 'force', 'auto'. >>

265

266

Here are some explanations on the possible values:

267

268

=over

269

270

=item 'auto'

271

272

request a TTY when opening a login session

273

274

=item 'force'

275

276

always request a TTY

277

278

=item 'no'

279

280

never request a TTY

281

282

=item 'yes'

283

284

always request a TTY when standard input is a TTY

285

286

=back

287

288

289

258

290

=head2 RhostsRSAAuthentication

259

291

260

292

Specifies whether to try rhosts based authentication with RSA host authentication. This option applies to protocol version 1 only and requires ssh(1) to be setuid root.I<< Optional. Type boolean. upstream_default: '0'. >>

Older »