Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
manpages: update all man pages from xml files
  • Loading branch information
Matthias Ruester committed Apr 29, 2013
1 parent c12e7ea commit e50efc2
Show file tree
Hide file tree
Showing 8 changed files with 691 additions and 742 deletions.
157 changes: 73 additions & 84 deletions manpages/bee-check.1.in
@@ -1,93 +1,82 @@
." manpage of bee-check
."
." Copyright (C) 2009-2012
." Marius Tolzmann <tolzmann@molgen.mpg.de>
." Tobias Dreyer <dreyer@molgen.mpg.de>
." and other bee developers
."
." This file is part of bee.
."
." bee 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.
."
." program 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.
."
." You should have received a copy of the GNU General Public License
." along with this program. If not, see <http://www.gnu.org/licenses/>.

.TH "bee-check" "1" "2012-08-31" "bee @BEE_VERSION@" "bee - bau et einfach"

'\" t
.\" Title: bee-check
.\" Author: Marius Tolzmann <tolzmann@molgen.mpg.de>
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 04/24/2013
.\" Manual: bee - bau et einfach
.\" Source: bee @BEE_VERSION@
.\" Language: English
.\"
.TH "BEE\-CHECK" "1" "04/24/2013" "bee @BEE_VERSION@" "bee - bau et einfach"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bee\-check \- Perform some consistency checks on a bee package

bee-check \- perform some consistency checks on a bee package
.SH "SYNOPSIS"
.SY "bee check"
.OP options
.I <pattern>
.YS

.HP \w'\fBbee\ check\fR\ 'u
\fBbee check\fR [options] \fI<pattern>\fR
.SH "DESCRIPTION"
.P
.B bee-check
.PP
\fBbee\-check\fR
is used to perform consistency checks on a bee package matching
.I <pattern>
and shows missing link targets, missing files and directories or changed md5 sums.

\fIpattern\fR
and shows missing link targets, missing files and directories or changed md5 sums\&.
.SH "OPTIONS"
.TP
.B \-d, \-\-deps, \-\-dependencies
Print package dependencies.
.TP
.B \-f, \-\-force
Use
.B \-\-force
to check all packages matching
.IR <pattern> ,
if it does not match a full packagename.
.TP
.B \-h, \-\-help
Print a little help screen.

.PP
\fB\-d, \-\-deps, \-\-dependencies\fR
.RS 4
Print package dependencies\&.
.RE
.PP
\fB\-f, \-\-force\fR
.RS 4
Check all packages matching
\fIpattern\fR
if it does not match a full packagename\&.
.RE
.PP
\fB\-h, \-\-help\fR
.RS 4
Print a usage message\&.
.RE
.SH "ENVIRONMENT"
.TP
.B BEE_METADIR
.RS
.PP
\fBBEE_METADIR\fR
.RS 4
Directory searched for installed bee packages
.RE
.SH "BUGS"
.PP
Please report bugs to bee\-dev@googlegroups\&.com or directly to the authors\&.
.SH "SEE ALSO"
.PP

\fBbee\fR(1),
\fBbee-download\fR(1),
\fBbee-init\fR(1),
\fBbee-install\fR(1),
\fBbee-list\fR(1),
\fBbee-query\fR(1),
\fBbee-remove\fR(1),
\fBbee-update\fR(1)
.SH "AUTHORS"
.P
.MT tolzmann@molgen.mpg.de
Marius Tolzmann
.ME
.br
.MT dreyer@molgen.mpg.de
Tobias Dreyer
.ME
.br
.MT ruester@molgen.mpg.de
Matthias Ruester
.ME
.br
and other bee developers

.SH "BEE"
.P
This file is part of bee.
.P
Please report bugs to bee-dev@googlegroups.com or directly to the authors.

.SH "SEE ALSO"
.BR bee (1)
.BR bee\-check (1)
.BR bee\-download (1)
.BR bee\-init (1)
.BR bee\-install (1)
.BR bee\-list (1)
.BR bee\-query (1)
.BR bee\-remove (1)
.BR bee\-update (1)
.PP
\fBMarius Tolzmann\fR <\&tolzmann@molgen\&.mpg\&.de\&>
.RS 4
.RE
.PP
\fBTobias Dreyer\fR <\&dreyer@molgen\&.mpg\&.de\&>
.RS 4
.RE
.PP
\fBand other bee developers\fR
.RS 4
.RE
169 changes: 82 additions & 87 deletions manpages/bee-download.1.in
@@ -1,95 +1,90 @@
." manpage of bee-download
."
." Copyright (C) 2009-2012
." Marius Tolzmann <tolzmann@molgen.mpg.de>
." Tobias Dreyer <dreyer@molgen.mpg.de>
." and other bee developers
."
." This file is part of bee.
."
." bee 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.
."
." program 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.
."
." You should have received a copy of the GNU General Public License
." along with this program. If not, see <http://www.gnu.org/licenses/>.

.TH "bee-download" "1" "2012-08-31" "bee @BEE_VERSION@" "bee - bau et einfach"

'\" t
.\" Title: bee-download
.\" Author: Marius Tolzmann <tolzmann@molgen.mpg.de>
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 04/24/2013
.\" Manual: bee - bau et einfach
.\" Source: bee @BEE_VERSION@
.\" Language: English
.\"
.TH "BEE\-DOWNLOAD" "1" "04/24/2013" "bee @BEE_VERSION@" "bee - bau et einfach"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
bee\-download \- Download a repository and convert it into a source tarball

bee-download \- Download a repository and convert it into a source tarball
.SH "SYNOPSIS"
.SY "bee download"
.OP options
.I <repository-url>
.YS

.HP \w'\fBbee\ download\fR\ 'u
\fBbee download\fR [options] \fI<repository\-url>\fR
.SH "DESCRIPTION"
.P
.B bee-download
is used to download a repository and convert it into a source tarball. This tarball can be used to
create a beefile via
.BR "bee init" .
.PP

\fBbee\-download\fR
is used to download a repository and convert it into a source tarball\&. This tarball can be used to create a beefile via
\fBbee\-init\fR\&.
.SH "OPTIONS"
.TP
.BI "\-n, \-\-pkgname" " <name>"
Specifiy the tarballs package name.
.TP
.BI "\-v, \-\-pkgversion" " <version>"
Specifiy the tarballs package version.
.TP
.BI "\-c, \-\-commit" " <rev>"
When downloading from a git repository: Use a certain commit as the HEAD revision.
.TP
.B \-t, \-\-type
Specify the type of download (http, https or git).
.TP
.B \-h, \-\-help
Print a little help screen.

.PP
\fB\-n\fR, \fB\-\-pkgname \fR\fB\fI<name>\fR\fR
.RS 4
Specify the tarball\'s package name\&.
.RE
.PP
\fB\-v\fR, \fB\-\-pkgversion \fR\fB\fI<version>\fR\fR
.RS 4
Specify the tarball\'s package version\&.
.RE
.PP
\fB\-c\fR, \fB\-\-commit \fR\fB\fI<rev>\fR\fR
.RS 4
When downloading from a git repository: Use a certain commit as the HEAD revision\&.
.RE
.PP
\fB\-t\fR, \fB\-\-type\fR
.RS 4
Specify the type of download (http, https or git)\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print a usage message\&.
.RE
.SH "ENVIRONMENT"
.TP
.B BEE_DOWNLOADDIR
.RS
The downloaded file is placed here.
.PP
\fBBEE_DOWNLOADDIR\fR
.RS 4
The downloaded file is placed here\&.
.RE
.SH "BUGS"
.PP
Please report bugs to bee\-dev@googlegroups\&.com or directly to the authors\&.
.SH "SEE ALSO"
.PP

\fBbee\fR(1),
\fBbee-check\fR(1),
\fBbee-init\fR(1),
\fBbee-install\fR(1),
\fBbee-list\fR(1),
\fBbee-query\fR(1),
\fBbee-remove\fR(1),
\fBbee-update\fR(1)
.SH "AUTHORS"
.P
.MT tolzmann@molgen.mpg.de
Marius Tolzmann
.ME
.br
.MT dreyer@molgen.mpg.de
Tobias Dreyer
.ME
.br
.MT ruester@molgen.mpg.de
Matthias Ruester
.ME
.br
and other bee developers

.SH "BEE"
.P
This file is part of bee.
.P
Please report bugs to bee-dev@googlegroups.com or directly to the authors.

.SH "SEE ALSO"
.BR bee (1)
.BR bee\-check (1)
.BR bee\-download (1)
.BR bee\-init (1)
.BR bee\-install (1)
.BR bee\-list (1)
.BR bee\-query (1)
.BR bee\-remove (1)
.BR bee\-update (1)
.PP
\fBMarius Tolzmann\fR <\&tolzmann@molgen\&.mpg\&.de\&>
.RS 4
.RE
.PP
\fBTobias Dreyer\fR <\&dreyer@molgen\&.mpg\&.de\&>
.RS 4
.RE
.PP
\fBand other bee developers\fR
.RS 4
.RE

0 comments on commit e50efc2

Please sign in to comment.