diff --git a/Makefile b/Makefile index 69a437c..6f34565 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/manpages/bee-check.1.in b/manpages/bee-check.1.in index fd1f354..0e14e54 100644 --- a/manpages/bee-check.1.in +++ b/manpages/bee-check.1.in @@ -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 .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 +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 , 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) diff --git a/manpages/bee-dep.1.in b/manpages/bee-dep.1.in index 14376d1..529accb 100644 --- a/manpages/bee-dep.1.in +++ b/manpages/bee-dep.1.in @@ -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 - [pkgname|file] -.PP -.SH DESCRIPTION +.SH "SYNOPSIS" +.SY "bee dep" + +.OP +.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 +.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) diff --git a/manpages/bee-download.1.in b/manpages/bee-download.1.in new file mode 100644 index 0000000..0e878ff --- /dev/null +++ b/manpages/bee-download.1.in @@ -0,0 +1,75 @@ +.TH "bee-download" "1" "2012-05-18" "bee @BEE_VERSION@" "bee - bau et einfach" + +.SH "NAME" +bee\-download \- Download a repository and convert it into a source tarball + +.SH "SYNOPSIS" +.SY "bee download" +.OP options +.I +.YS + +.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" . + +.SH "OPTIONS" +.TP +.BI \-\-pkgname " " +Specifiy the tarballs package name. +.TP +.BI \-\-pkgversion " " +Specifiy the tarballs package version. +.TP +.BI \-\-commit " " +Use a certain +.I +as HEAD revision. +.TP +.B \-\-help +.TQ +.B \-h +Print a little help screen. + +.SH "ENVIRONMENT" +.TP +.B BEE_DOWNLOADDIR +.RS +The source tarball is placed here. + +.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\-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) diff --git a/manpages/bee-init.1.in b/manpages/bee-init.1.in index 25bf9c4..28ec636 100644 --- a/manpages/bee-init.1.in +++ b/manpages/bee-init.1.in @@ -1,65 +1,64 @@ -.TH "bee-init" "1" "2011-07-25" "bee @BEE_VERSION@" "bee package management" +.TH "bee-init" "1" "2012-05-18" "bee @BEE_VERSION@" "bee - bau et einfach" + .SH "NAME" bee\-init \- Create a bee file for building a bee package + .SH "SYNOPSIS" .SY "bee init" -.OP \-fh -.OP \-\-configure mode -.OP \-\-disable-versionify -.OP \-t template -.I url-to-file +.OP options +.I +.OP "-- configure options" .YS + .SH "DESCRIPTION" .P .B bee-init is used to create a file, that is run in order to build a bee package. + .SH "OPTIONS" .TP -.BI \-\-configure " mode" -Set -.I mode -to 'compat' if DATAROOTDIR is not supported in your build process +.BI \-\-configure " " +Set to 'compat' if DATAROOTDIR is not supported in your build process .TP -.BI \-\-buildtype " TYPE" +.BI \-\-buildtype " " force buildtype: configure, cmake, make, autogen, perl-module, perl-module-makemaker, python-module .TP .B \-\-disable-versionify Enable this flag, if you do not want that version numbers in your source url are substituted for bee variables. .TP -.BI -t " template" +.BI --template "