From d1a294ec455bd6ad57e96064a8494e7e660051a2 Mon Sep 17 00:00:00 2001 From: Thomas Liske Date: Tue, 29 May 2012 14:42:35 +0200 Subject: [PATCH] Update man pages. --- man/apt-dater.8 | 48 ++++++++++++++++++++++++++++------------- man/apt-dater.conf.5 | 6 +++--- man/apt-dater.conf.html | 14 ++++++------ man/apt-dater.conf.xml | 4 ++-- man/apt-dater.html | 6 +++--- man/apt-dater.xml | 4 ++-- 6 files changed, 50 insertions(+), 32 deletions(-) diff --git a/man/apt-dater.8 b/man/apt-dater.8 index 90a20cc8..407cab48 100644 --- a/man/apt-dater.8 +++ b/man/apt-dater.8 @@ -1,19 +1,36 @@ +'\" t .\" Title: APT-DATER .\" Author: Andre Ellguth -.\" Generator: DocBook XSL Stylesheets v1.73.2 -.\" Date: May 23, 2009 -.\" Manual: -.\" Source: +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: May 29, 2012 +.\" Manual: [FIXME: manual] +.\" Source: [FIXME: source] +.\" Language: English .\" -.TH "APT\-DATER" "8" "May 23, 2009" "" "" +.TH "APT\-DATER" "8" "May 29, 2012" "[FIXME: source]" "[FIXME: manual]" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- .SH "NAME" -apt-dater \- terminal-based remote package update manager +apt-dater \- terminal\-based remote package update manager .SH "SYNOPSIS" -.HP 10 +.HP \w'\fBapt\-dater\fR\ 'u \fBapt\-dater\fR [\fB[\-(c\ \fR\fB\fIconfig\fR\fR\fB|v|[n]r)]\fR] .SH "DESCRIPTION" .PP @@ -52,7 +69,7 @@ Prevent hosts to be refreshed before create XML report (useful for cronjobs whic .PP \fBMAINTAINER\fR .RS 4 -The maintainer\'s name (i\&.e\&. used by +The maintainer\*(Aqs name (i\&.e\&. used by \fBdebtrack\fR)\&. If not set, the GECOS entry for the current user will be used\&. This environment variable could be forwarded to remote hosts with the ssh(1) SendEnv+AcceptEnv options\&. .RE .SH "FILES" @@ -72,19 +89,20 @@ apt\-dater\&.conf(5), aptitude(1), apt\-get(1), debtrack, screen(1), ssh(1)\&. .SH "AUTHORS" .PP \fBAndre Ellguth\fR <\&ellguth@ibh\&.de\&> -.sp -1n -.IP "" 4 +.RS 4 Maintainer\&. +.RE .PP \fBThomas Liske\fR <\&liske@ibh\&.de\&> -.sp -1n -.IP "" 4 +.RS 4 Maintainer\&. +.RE .PP \fBJens Haser\fR <\&jens_dd@hotmail\&.de\&> -.sp -1n -.IP "" 4 +.RS 4 Fixed some UI glitches\&. +.RE .SH "COPYRIGHT" -Copyright \(co 2008 IBH IT-Service GmbH [\fIhttp://www\&.ibh\&.de/\fR] +.br +Copyright \(co 2008-2012 IBH IT-Service GmbH [\m[blue]\fBhttp://www\&.ibh\&.de/\fR\m[]] .br diff --git a/man/apt-dater.conf.5 b/man/apt-dater.conf.5 index dc2d4dd9..7107f398 100644 --- a/man/apt-dater.conf.5 +++ b/man/apt-dater.conf.5 @@ -2,12 +2,12 @@ .\" Title: APT-DATER .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.76.1 -.\" Date: May 23, 2009 +.\" Date: May 29, 2012 .\" Manual: [FIXME: manual] .\" Source: [FIXME: source] .\" Language: English .\" -.TH "APT\-DATER" "5" "May 23, 2009" "[FIXME: source]" "[FIXME: manual]" +.TH "APT\-DATER" "5" "May 29, 2012" "[FIXME: source]" "[FIXME: manual]" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -306,7 +306,7 @@ apt\-dater(8), aptitude(1), apt\-get(1), debtrack, screen(1), script(1), ssh(1), \m[blue]\fBXDG Base Directory Specification\fR\m[]\&\s-2\u[1]\d\s+2\&. .SH "COPYRIGHT" .br -Copyright \(co 2008-2009 IBH IT-Service GmbH [\m[blue]\fBhttp://www\&.ibh\&.de/\fR\m[]] +Copyright \(co 2008-2012 IBH IT-Service GmbH [\m[blue]\fBhttp://www\&.ibh\&.de/\fR\m[]] .br .SH "NOTES" .IP " 1." 4 diff --git a/man/apt-dater.conf.html b/man/apt-dater.conf.html index f3d564da..3e4188a8 100644 --- a/man/apt-dater.conf.html +++ b/man/apt-dater.conf.html @@ -1,4 +1,4 @@ -APT-DATER

Name

apt-dater.conf — configuration file of apt-dater(8)

Synopsis

[Section]

parameter=value

parameter=value;value;...;

DESCRIPTION

The file apt-dater.conf is the +APT-DATER

Name

apt-dater.conf — configuration file of apt-dater(8)

Synopsis

[Section]

parameter=value

parameter=value;value;...;

DESCRIPTION

The file apt-dater.conf is the configuration file for apt-dater(8). apt-dater(8) is a program to manage package updats on a large number of remote hosts using SSH. @@ -7,17 +7,17 @@ The default location of this file is $XDG_CONFIG_HOME/apt-dater/hosts.conf.

The syntax of the configuration file is the syntax of glib keyfiles. -

OPTIONS

Section [Paths]

HostsFile=$XDG_CONFIG_HOME/apt-dater/hosts.conf

The location of the file contains all host which will be managed with apt-dater. (optional)

StatsDir=$XDG_DATA_HOME/apt-dater

The location of the directory which contains the status files of any host. (optional)

Section [Screen]

RCFile=$XDG_CONFIG_HOME/apt-dater/screenrc

Location of screen(1) config file. (optional)

Title=%m # %u@%h:%p

Template for screen titles using string escapes. (optional)

NoDumps=false

Enables/disables support of screen dumps. (optional)

QueryMaintainer=0

If set to 1, apt-dater will ask for the maintainers name on startup. If set to 2, apt-dater will only ask if no MAINTAINER environment variable is set.

Section [SSH]

Cmd=/usr/bin/ssh

The location of ssh-client binary.

SFTPCmd

The command to initiate sftp file transfer e.g. /usr/bin/sftp

OptionalCmdFlags

Additional ssh-client command flags, which will be appended.

SpawnAgent=false

If enabled, apt-dater tries to spawn ssh-agent(1) if none is already running. ssh-add(1) will be called to load your private keys.

AddKeys

List of private keys which should be loaded when apt-dater calls ssh-add(1).

Section [Commands]

CmdRefresh=apt-dater-host refresh

The command which will be used to refresh the status of the managed host.

CmdUpgrade=apt-dater-host upgrade

The command which will be used to intitate a upgrade of a managed host.

CmdInstall=apt-dater-host install %s

The command which will be used to update a single package. %s will be replaced by the name of the package.

Section [Appearance]

Colors

Set your own color style of the ui components. To highlight colors you can use the bright* keyword. +

OPTIONS

Section [Paths]

HostsFile=$XDG_CONFIG_HOME/apt-dater/hosts.conf

The location of the file contains all host which will be managed with apt-dater. (optional)

StatsDir=$XDG_DATA_HOME/apt-dater

The location of the directory which contains the status files of any host. (optional)

Section [Screen]

RCFile=$XDG_CONFIG_HOME/apt-dater/screenrc

Location of screen(1) config file. (optional)

Title=%m # %u@%h:%p

Template for screen titles using string escapes. (optional)

NoDumps=false

Enables/disables support of screen dumps. (optional)

QueryMaintainer=0

If set to 1, apt-dater will ask for the maintainers name on startup. If set to 2, apt-dater will only ask if no MAINTAINER environment variable is set.

Section [SSH]

Cmd=/usr/bin/ssh

The location of ssh-client binary.

SFTPCmd

The command to initiate sftp file transfer e.g. /usr/bin/sftp

OptionalCmdFlags

Additional ssh-client command flags, which will be appended.

SpawnAgent=false

If enabled, apt-dater tries to spawn ssh-agent(1) if none is already running. ssh-add(1) will be called to load your private keys.

AddKeys

List of private keys which should be loaded when apt-dater calls ssh-add(1).

Section [Commands]

CmdRefresh=apt-dater-host refresh

The command which will be used to refresh the status of the managed host.

CmdUpgrade=apt-dater-host upgrade

The command which will be used to intitate a upgrade of a managed host.

CmdInstall=apt-dater-host install %s

The command which will be used to update a single package. %s will be replaced by the name of the package.

Section [Appearance]

Colors

Set your own color style of the ui components. To highlight colors you can use the bright* keyword. Example: Colors=menu brightgreen blue;status brightgreen blue;selector black red;

. -

Components are:

Colors are:

Section [AutoRef]

enabled=true

Enabled the auto refresh feature if compiled in (see README.autoref).

Section [Notify]

bell=true

Enables user notification by terminal bell.

flash=true

Enables user notification by terminal flashing.

Section [History]

ErrPattern=(error|warning|fail)

+

Components are:

Colors are:

Section [AutoRef]

enabled=true

Enabled the auto refresh feature if compiled in (see README.autoref).

Section [Notify]

bell=true

Enables user notification by terminal bell.

flash=true

Enables user notification by terminal flashing.

Section [History]

ErrPattern=(error|warning|fail)

A regular expression pattern to match the screen output. A match indicates - the user should be asked to review the output (using less). (Optional)

record=true

Enables session recording using script(1). (Optional)

Section [Hooks]

PreUpdate=/etc/apt-dater/pre-upg.d, PreRefresh=/etc/apt-dater/pre-ref.d, PreInstall=/etc/apt-dater/pre-ins.d, PreConnect=/etc/apt-dater/pre-con.d, PostUpdate=/etc/apt-dater/post-upg.d, PostRefresh=/etc/apt-dater/post-ref.d, PostInstall=/etc/apt-dater/post-ins.d, PostConnect=/etc/apt-dater/post-con.d

+ the user should be asked to review the output (using less). (Optional)

record=true

Enables session recording using script(1). (Optional)

Section [Hooks]

PreUpdate=/etc/apt-dater/pre-upg.d, PreRefresh=/etc/apt-dater/pre-ref.d, PreInstall=/etc/apt-dater/pre-ins.d, PreConnect=/etc/apt-dater/pre-con.d, PostUpdate=/etc/apt-dater/post-upg.d, PostRefresh=/etc/apt-dater/post-ref.d, PostInstall=/etc/apt-dater/post-ins.d, PostConnect=/etc/apt-dater/post-con.d

Hooks to be run before and after an action on a host is done. The values should be path names, any executable script within these directories will be run by run-parts(8). -

STRING ESCAPES

apt-dater(8) provides an string escape mechanism. The escape character is '%'. +

STRING ESCAPES

apt-dater(8) provides an string escape mechanism. The escape character is '%'. - List of supported escapes. +
List of supported escapes. @@ -35,4 +35,4 @@ -
escape replaced by
u SSH username

FILES

apt-dater.conf

The configuration file of apt-dater.

hosts.conf

Contains all hosts you would like to manage.

SEE ALSO

apt-dater(8), aptitude(1), apt-get(1), debtrack, screen(1), script(1), ssh(1), XDG Base Directory Specification.

+

FILES

apt-dater.conf

The configuration file of apt-dater.

hosts.conf

Contains all hosts you would like to manage.

SEE ALSO

apt-dater(8), aptitude(1), apt-get(1), debtrack, screen(1), script(1), ssh(1), XDG Base Directory Specification.

diff --git a/man/apt-dater.conf.xml b/man/apt-dater.conf.xml index 6ab7ea94..ae6c08ab 100644 --- a/man/apt-dater.conf.xml +++ b/man/apt-dater.conf.xml @@ -30,7 +30,7 @@ and docbook-xsl in your Build-Depends control field. Andre"> Ellguth"> - May 23, 2009"> + May 29, 2012"> 5"> @@ -72,7 +72,7 @@ and docbook-xsl in your Build-Depends control field. --> - 2008-2009 + 2008-2012 IBH IT-Service GmbH [http://www.ibh.de/] &dhdate; diff --git a/man/apt-dater.html b/man/apt-dater.html index b72af40d..1af76b3e 100644 --- a/man/apt-dater.html +++ b/man/apt-dater.html @@ -1,4 +1,4 @@ -APT-DATER

Name

apt-dater — terminal-based remote package update manager

Synopsis

apt-dater [[-(c config|v|[n]r)]]

DESCRIPTION

This manual page documents briefly the +APT-DATER

Name

apt-dater — terminal-based remote package update manager

Synopsis

apt-dater [[-(c config|v|[n]r)]]

DESCRIPTION

This manual page documents briefly the apt-dater command.

apt-dater is a program to manage package updats on a large - number of remote hosts using SSH.

OPTIONS

apt-dater accepts the following command parameters:

-c config

Use alternative config file. Default is $XDG_CONFIG_HOME/apt-dater/apt-dater.conf.

-v

Show apt-dater version and copyright statement.

-r

Refresh hosts and create XML report on stdout. apt-dater must be compiled with XMLREPORT feature.

-n

Prevent hosts to be refreshed before create XML report (useful for cronjobs which do not have access to SSH key(s)).

ENVIRONMENT

MAINTAINER

The maintainer's name (i.e. used by debtrack). If not set, the GECOS entry for the current user will be used. - This environment variable could be forwarded to remote hosts with the ssh(1) SendEnv+AcceptEnv options.

FILES

~/.config/apt-dater/apt-dater.conf

The configuration file of apt-dater

~/.config/apt-dater/hosts.conf

Contains all hosts you would like to manage

SEE ALSO

apt-dater.conf(5), aptitude(1), apt-get(1), debtrack, screen(1), ssh(1).

+ number of remote hosts using SSH.

OPTIONS

apt-dater accepts the following command parameters:

-c config

Use alternative config file. Default is $XDG_CONFIG_HOME/apt-dater/apt-dater.conf.

-v

Show apt-dater version and copyright statement.

-r

Refresh hosts and create XML report on stdout. apt-dater must be compiled with XMLREPORT feature.

-n

Prevent hosts to be refreshed before create XML report (useful for cronjobs which do not have access to SSH key(s)).

ENVIRONMENT

MAINTAINER

The maintainer's name (i.e. used by debtrack). If not set, the GECOS entry for the current user will be used. + This environment variable could be forwarded to remote hosts with the ssh(1) SendEnv+AcceptEnv options.

FILES

~/.config/apt-dater/apt-dater.conf

The configuration file of apt-dater

~/.config/apt-dater/hosts.conf

Contains all hosts you would like to manage

SEE ALSO

apt-dater.conf(5), aptitude(1), apt-get(1), debtrack, screen(1), ssh(1).

diff --git a/man/apt-dater.xml b/man/apt-dater.xml index f75f28e7..3304435a 100644 --- a/man/apt-dater.xml +++ b/man/apt-dater.xml @@ -30,7 +30,7 @@ and docbook-xsl in your Build-Depends control field. Thomas"> Liske"> - May 23, 2009"> + May 29, 2012"> 8"> @@ -70,7 +70,7 @@ and docbook-xsl in your Build-Depends control field. - 2008 + 2008-2012 IBH IT-Service GmbH [http://www.ibh.de/] &dhdate;