Skip to content

Commit

Permalink
Merge branch 'manpages' of https://github.com/tewdreyer/bee
Browse files Browse the repository at this point in the history
* 'manpages' of https://github.com/tewdreyer/bee:
  manpages: improve content
  • Loading branch information
mariux committed May 20, 2012
2 parents ed25d14 + f98a912 commit 3765aec
Show file tree
Hide file tree
Showing 11 changed files with 449 additions and 425 deletions.
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ HELPER_HOOKS_SHELL=update-mime-database glib-compile-schemas mkfontdir-mkfontsca
ldconfig update-desktop-database gdk-pixbuf-query-loaders mandb systemd-tmpfiles \
gconf-install-schemas info-dir

MANPAGES=bee.1 bee-check.1 bee-init.1 bee-install.1 bee-list.1 bee-query.1 bee-remove.1 bee-dep.1
MANPAGES=bee.1 bee-check.1 bee-init.1 bee-install.1 bee-list.1 bee-query.1 bee-remove.1 bee-dep.1 \
bee-update.1 bee-download.1

CONFIG_TEMPLATES=fallback
CONFIG_FILES=skiplist beerc
Expand Down
84 changes: 44 additions & 40 deletions manpages/bee-check.1.in
Original file line number Diff line number Diff line change
@@ -1,76 +1,80 @@
.TH "bee-check" "1" "2011-07-25" "bee @BEE_VERSION@" "bee package management"
.TH "bee-check" "1" "2012-05-16" "bee @BEE_VERSION@" "bee - bau et einfach"

.SH "NAME"
bee\-check \- Perform some consistency checks on a bee package

.SH "SYNOPSIS"
.SY "bee check"
.OP \-dfh
.I pattern
.OP options
.I <pattern>
.YS

.SH "DESCRIPTION"
.P
.B bee-check
is used to perform consistency checks on a bee package and shows missing link targets,
missing files and directories or changed md5 sums.
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.

.SH "OPTIONS"
.TP
.B \-d
.B \-\-dependencies
.TQ
.B \-\-deps
.TQ
.B \-d
Print package's dependencies
.TP
.B \-f
.TQ
.B \-\-force
Use
.TQ
.B \-f
Use
.B \-\-force
to check all packages matching
.IR pattern ,
.IR <pattern> ,
if it does not match a full packagename.
.TP
.B \-h
.TQ
.B \-\-help
Print a little help screen.
.TP
.B \-v
.TQ
.B \-\-verbose
bee more verbose (can be used twice e.g. -vv)
.SH "FILES"
.TP
.B /etc/bee/beerc
.TQ
.B ~/.beerc
The main config files. Use these to change
.BR bee-check 's
environment variables.
.B \-h
Print a little help screen.

.SH "ENVIRONMENT"
.TP
.B BEE_METADIR
.RS
Directory searched for installed bee packages
.P
Defaults:
.TQ
root-user: /usr/share/bee
.TQ
other: ~/.local/share/bee
.RE
.\" .SH "BUGS"

.SH "AUTHORS"
.P
.MT tolzmann@molgen.mpg.de
Marius Tolzmann
.ME
.P
.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 beesh (1)
.BR bee-init (1)
.BR bee-install (1)
.BR bee-list (1)
.BR bee-query (1)
.BR bee-remove (1)
.BR bee\-check (1)
.BR bee\-dep (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)
190 changes: 67 additions & 123 deletions manpages/bee-dep.1.in
Original file line number Diff line number Diff line change
@@ -1,142 +1,86 @@
.de Vb
.ft CW
.nf
..
.de Ve
.ft R
.TH "bee\-dep" "1" "2012-05-16" "bee @BEE_VERSION@" "bee - bau et einfach"

.fi
..
.TH "bee\-dep" "1" "2012-01-26" "bee @BEE_VERSION@" "bee package management"
.SH NAME

.PP
.SH "NAME"
bee\-dep \- bee dependency tool
.PP
.SH SYNOPSIS

\fBbee dep\fP
<command> [pkgname|file]
.PP
.SH DESCRIPTION
.SH "SYNOPSIS"
.SY "bee dep"
<command>
.OP <args>
.YS

\fBbee\-dep\fP
reads the
.ul
DEPENDENCIES
file
of every installed package and is able to query several information about the packages.
.br
.PP
As part of the bee package management \fBbee\-dep\fP
is invoked by the wrapper tool \fBbee\fP(1).
.PP
.SH COMMANDS
.SH "DESCRIPTION"
.B bee\-dep
reads the DEPENDENCIES file of every installed package and is able to query several information about the packages.

.PP
\fBrebuild\fP
.RS
Rebuild the cache. Therefore the old cache is deleted and then recreated with the information of the
.ul
DEPENDENCIES
file of each installed package.
.RS
.PP
.RE
.RE
.PP
\fBupdate\fP
\fIpkgname\fP
.RS
.SH "COMMANDS"
.TP
.B rebuild
Rebuild the cache. Therefore the old cache is deleted and then recreated with the information of the DEPENDENCIES file of each installed package.
.SY update
.OP pkgname
.YS
Update the cache for a specific package.
.PP
.RE
.RE
.PP
\fBremove\fP
[options] \fIpkgname\fP
.RS
.SY remove
.OP options
.I <pkgname>
.YS
Remove a package from the cache.
.PP
.RE
.RE
.PP
\fBlist\fP
[options] \fIpkgname\fP
.RS
.SY list
.OP options
.OP pkgname
.YS
Query information about a package.
.PP
.RE
.RE
.PP
\fBconflicts\fP
.RS
.TP
.B conflicts
Show conflicting packages.
.PP
.RE
.RE
.PP
.SH FILES

\fB/etc/bee/beerc\fP
.br
\fB${HOME}/.beerc\fP
.RS
The main config files. Use these to change \fBbee\-dep\fP\&'s
environment variables.
.RE
.RE
.PP
.SH ENVIRONMENT

\fB${BEE_METADIR}\fP
.br
.RS
.SH "ENVIRONMENT"
.TP
BEE_METADIR
Directory where to search for installed bee packages
.br
.PP
root\-user: /usr/share/bee
.br
other: ${HOME}/.local/share/beemeta
.br
.RE
.RE
.PP
\fB${BEE_CACHEDIR}\fP
.br
.RS
Directory where to save the cache file
.ul
index.db
.TP
BEE_CACHEDIR
Directory where to save and read the cache file
.I index.db
and
the lock file
.ul
index.lock
.I index.lock

.SH "AUTHORS"
.P
.MT ruester@molgen.mpg.de
Matthias Ruester
.ME
.br
root\-user: /var/cache/bee
.br
other: ${HOME}/.cache/bee
.MT schwass@molgen.mpg.de
Lucas Schwass
.ME
.br
.RE
.RE
.PP
.SH AUTHORS

Matthias Ruester <\fBruester@molgen.mpg.de\fP>
.br
Lucas Schwass <\fBschwass@molgen.mpg.de\fP>
.MT tolzmann@molgen.mpg.de
Marius Tolzmann
.ME
.br
Marius Tolzmann <\fBtolzmann@molgen.mpg.de\fP>
.MT dreyer@molgen.mpg.de
Tobias Dreyer
.ME
.br
Tobias Dreyer <\fBdreyer@molgen.mpg.de\fP>
.PP
.SH SEE ALSO
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.

\fBbee\fP(1)
\fBbee\-init\fP(1)
\fBbee\-check\fP(1)
\fBbee\-install\fP(1)
\fBbee\-list\fP(1)
\fBbee\-query\fP(1)
\fBbee\-remove\fP(1)
.SH "SEE ALSO"
.BR bee (1)
.BR bee\-check (1)
.BR bee\-dep (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)
Loading

0 comments on commit 3765aec

Please sign in to comment.