From d22b1813e3be2fddbb644542318f708f42e8a8c6 Mon Sep 17 00:00:00 2001 From: Matthias Ruester Date: Mon, 29 Apr 2013 16:24:25 +0200 Subject: [PATCH 1/5] Makefile: do not put man pages in the manpages subdirectory this puts the resulting man pages in the current directory --- Makefile | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index 3875459..1a4f61d 100644 --- a/Makefile +++ b/Makefile @@ -136,12 +136,11 @@ BEEGETOPT_OBJECTS=bee_getopt.o beegetopt.o BEEFLOCK_OBJECTS=bee_getopt.o beeflock.o BEECACHEINVENTORY_OBJECTS=bee-cache-inventory.o bee_getopt.o -bee_MANPAGES=$(addprefix manpages/,${MANPAGES}) bee_BUILDTYPES=$(addsuffix .sh,$(addprefix buildtypes/,$(BUILDTYPES))) shellscripts: $(addsuffix .sh,$(SHELLSCRIPTS)) $(LIBRARY_SHELL) cprograms: $(PROGRAMS_C) ${HELPER_C} -manpages: ${bee_MANPAGES} +manpages: $(MANPAGES) buildtypes: ${bee_BUILDTYPES} beesep: $(addprefix src/, ${BEESEP_OBJECTS}) @@ -174,7 +173,7 @@ bee-cache-inventory: $(addprefix src/, ${BEECACHEINVENTORY_OBJECTS}) %.sh: src/%.sh.in $(call quiet-command,sed ${sed-rules} $< >$@,"SED $@") -%.1: %.1.in +%.1: manpages/%.1.in $(call quiet-command,sed ${sed-rules} $< >$@,"SED $@") %.sh: %.sh.in @@ -185,7 +184,7 @@ clean: $(call quiet-command,rm -f ${PROGRAMS_C},"CLEAN ${PROGRAMS_C}") $(call quiet-command,rm -f ${HELPER_C},"CLEAN ${HELPER_C}") $(call quiet-command,rm -f src/*.o,"CLEAN c object files") - $(call quiet-command,rm -f ${bee_MANPAGES},"CLEAN manpages") + $(call quiet-command,rm -f ${MANPAGES},"CLEAN manpages") $(call quiet-command,rm -f ${bee_BUILDTYPES},"CLEAN buildtypes") install: install-core install-config @@ -254,7 +253,7 @@ install-man: $(addprefix ${DESTDIR}${MANDIR}/man1/,${MANPAGES}) install-dir-mandir: $(call quiet-installdir,0755,${DESTDIR}${MANDIR}/man1) -${DESTDIR}${MANDIR}/man1/%.1: manpages/%.1 install-dir-mandir +${DESTDIR}${MANDIR}/man1/%.1: %.1 install-dir-mandir $(call quiet-install,0644,$<,$@) install-dir-config: From ae6693dbe2cf8e4599b35e7d86ebc7d3f0045a29 Mon Sep 17 00:00:00 2001 From: Lena Kristin Zander Date: Tue, 23 Apr 2013 10:56:12 +0200 Subject: [PATCH 2/5] manpages: add man pages in xml format --- manpages/bee-check.xml | 138 +++++++++++++++++++++ manpages/bee-download.xml | 159 ++++++++++++++++++++++++ manpages/bee-init.xml | 255 ++++++++++++++++++++++++++++++++++++++ manpages/bee-install.xml | 184 +++++++++++++++++++++++++++ manpages/bee-list.xml | 186 +++++++++++++++++++++++++++ manpages/bee-query.xml | 128 +++++++++++++++++++ manpages/bee-remove.xml | 133 ++++++++++++++++++++ manpages/bee.xml | 161 ++++++++++++++++++++++++ 8 files changed, 1344 insertions(+) create mode 100644 manpages/bee-check.xml create mode 100644 manpages/bee-download.xml create mode 100644 manpages/bee-init.xml create mode 100644 manpages/bee-install.xml create mode 100644 manpages/bee-list.xml create mode 100644 manpages/bee-query.xml create mode 100644 manpages/bee-remove.xml create mode 100644 manpages/bee.xml diff --git a/manpages/bee-check.xml b/manpages/bee-check.xml new file mode 100644 index 0000000..87c8f8c --- /dev/null +++ b/manpages/bee-check.xml @@ -0,0 +1,138 @@ + + + + + + + + bee - bau et einfach + bee @BEE_VERSION@ + + + + + Marius + Tolzmann + tolzmann@molgen.mpg.de + + + + + Tobias + Dreyer + dreyer@molgen.mpg.de + + + + + and other bee developers + + + + + + bee-check + 1 + + + + bee-check + perform some consistency checks on a bee package + + + + + bee check + options + <pattern> + + + + + Description + + bee-check is used to perform + consistency checks on a bee package matching + pattern and shows missing link + targets, missing files and directories or changed + md5 sums. + + + + Options + + + + + + Print package dependencies. + + + + + + Check all packages matching pattern if it does not match a full packagename. + + + + + + Print a usage message. + + + + + + Environment + + + + + Directory searched for installed bee packages + + + + + + Bugs + + Please report bugs to bee-dev@googlegroups.com or directly to the authors. + + + + + See Also + + bee1, + bee-download1, + bee-init1, + bee-install1, + bee-list1, + bee-query1, + bee-remove1, + bee-update1 + + + diff --git a/manpages/bee-download.xml b/manpages/bee-download.xml new file mode 100644 index 0000000..c6f88e7 --- /dev/null +++ b/manpages/bee-download.xml @@ -0,0 +1,159 @@ + + + + + + + + bee - bau et einfach + bee @BEE_VERSION@ + + + + + Marius + Tolzmann + tolzmann@molgen.mpg.de + + + + + Tobias + Dreyer + dreyer@molgen.mpg.de + + + + + and other bee developers + + + + + + bee-download + 1 + + + + bee-download + Download a repository and convert it into a source tarball + + + + + bee download + options + <repository-url> + + + + + Description + + + 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 + bee-init. + + + + + Options + + + + + + + Specify the tarball's package name. + + + + + + + Specify the tarball's package version. + + + + + + + + When downloading from a git repository: Use a certain commit + as the HEAD revision. + + + + + + + + + Specify the type of download (http, https or git). + + + + + + + + Print a usage message. + + + + + + Environment + + + + + The downloaded file is placed here. + + + + + + Bugs + + Please report bugs to bee-dev@googlegroups.com or directly to the authors. + + + + + See Also + + bee1, + bee-check1, + bee-init1, + bee-install1, + bee-list1, + bee-query1, + bee-remove1, + bee-update1 + + + diff --git a/manpages/bee-init.xml b/manpages/bee-init.xml new file mode 100644 index 0000000..0c05e09 --- /dev/null +++ b/manpages/bee-init.xml @@ -0,0 +1,255 @@ + + + + + + + + bee - bau et einfach + bee @BEE_VERSION@ + + + + + Marius + Tolzmann + tolzmann@molgen.mpg.de + + + + + Tobias + Dreyer + dreyer@molgen.mpg.de + + + + + and other bee developers + + + + + + bee-init + 1 + + + + bee-init + Create a bee file for building a bee package + + + + + bee init + options + <url-to-source> + -- configure options + + + + + Description + + bee-init is used to create + a file, that is run in order to build a bee package. + + + + + Options + + + + + + + Use the configure mode 'compat' if DATAROOTDIR + is not supported in your build process. + + + + + + + + Force builtype: configure, cmake, make, autogen, perl-module, + perl-module-makemaker, phython-module + + + + + + + + Do not substitute version numbers in the source url. + + + + + + + + + Overwrite already existing bee-file. + + + + + + + Print a usage message. + + + + + + + Print version number. + + + + + + + + Define environment variables within the bee-file. + Extra (over)quoting may be needed if B contains spaces. + + + + + + + + + Name of the new bee-file. + + + + + + + + + Execute the bee-file after creation. + + + + + + + + + Execute the bee-file and install software. + + + + + + + Naming bee-files + + + + + + + Add pkgextraname '_NAME' to bee-file-name. + + + + + + + + Prefix bee-file with 'NAME-'. + + + + + + + Installation Directories + + + + + + + + + + + + + + + + + + + + + Set these directories, if you do not want + to install to the default locations. + + + + + + Configure Options + + Package specific configure options may be appended at the end of your + bee-init line, e.g. + bee init http://ftp.gnome.org/pub/gnome/sources/gtk+/3.5/gtk+-3.5.2.tar.xz + -- --enable-introspection --enable-xinerama + will automatically append + --enable-introspection and --enable-xinerama + to the bee_configure call in your bee-file. + + + + + Bugs + + Please report bugs to bee-dev@googlegroups.com or directly to the authors. + + + + + See Also + + bee1, + bee-check1, + bee-download1, + bee-install1, + bee-list1, + bee-query1, + bee-remove1, + bee-update1 + + + diff --git a/manpages/bee-install.xml b/manpages/bee-install.xml new file mode 100644 index 0000000..cf55d32 --- /dev/null +++ b/manpages/bee-install.xml @@ -0,0 +1,184 @@ + + + + + + + + bee - bau et einfach + bee @BEE_VERSION@ + + + + + Marius + Tolzmann + tolzmann@molgen.mpg.de + + + + + Tobias + Dreyer + dreyer@molgen.mpg.de + + + + + and other bee developers + + + + + + bee-install + 1 + + + + bee-install + Install a bee package + + + + + bee install + options + <bee-package> + + + bee update + options + <bee-package> + + + + + Description + + + bee-install is used to install a bee package. + + + Normally bee-install searches BEE_PKGDIR + for <bee-package> but you can use + /path/to/<bee-package>.bee.tar.bz2 too. + + bee-update is the short form of 'bee install --update'. + + + + Options + + + + + + + + Prevent bee-install from checking whether + <bee-package> + is already installed. + + + + + + + + + + Update an installed + <bee-package>. + + + + + + + + + Do not install. Just print which files would be installed. + + + + + + + + + When updating: Remove all older versions of the package. + + + + + + + + + Be more verbose (can be use twice e.g. -vv). + + + + + + + + Print a usage message. + + + + + + Environment + + + + + Directory searched for available bee packages + + + + + + Bugs + + Please report bugs to bee-dev@googlegroups.com or directly to the authors. + + + + + See Also + + bee1, + bee-check1, + bee-download1, + bee-init1, + bee-list1, + bee-query1, + bee-remove1, + bee-update1 + + + diff --git a/manpages/bee-list.xml b/manpages/bee-list.xml new file mode 100644 index 0000000..ad1c9d8 --- /dev/null +++ b/manpages/bee-list.xml @@ -0,0 +1,186 @@ + + + + + + + + bee - bau et einfach + bee @BEE_VERSION@ + + + + + Marius + Tolzmann + tolzmann@molgen.mpg.de + + + + + Tobias + Dreyer + dreyer@molgen.mpg.de + + + + + and other bee developers + + + + + + bee-list + 1 + + + + bee-list + List bee packages + + + + + bee list + options + <pattern> + + + + + Description + + bee-list is used to display all bee packages that + are installed, available, uninstalled or updatable. + + + + + Options + + + + + + + + List all bee packages available for installation matching + <pattern>. + + + + + + + + + Use this option, if you want <pattern> + to match the full package name. + + + + + + + + + List all installed bee packages matching + <pattern>. + This is the default. + + + + + + + + + List all packages that can bee updated. + + + + + + + + + List all uninstalled packages. + + + + + + + Show pathname when listing available packages. + + + + + + + Print a usage message. + + + + + + Environment + + + + + Directory searched for installed bee packages + + + + + + + Directory searched for available bee packages + + + + + + Bugs + + Please report bugs to bee-dev@googlegroups.com or directly to the authors. + + + + + See Also + + bee1, + bee-check1, + bee-download1, + bee-init1, + bee-install1, + bee-query1, + bee-remove1, + bee-update1 + + + diff --git a/manpages/bee-query.xml b/manpages/bee-query.xml new file mode 100644 index 0000000..2848637 --- /dev/null +++ b/manpages/bee-query.xml @@ -0,0 +1,128 @@ + + + + + + + + bee - bau et einfach + bee @BEE_VERSION@ + + + + + Marius + Tolzmann + tolzmann@molgen.mpg.de + + + + + Tobias + Dreyer + dreyer@molgen.mpg.de + + + + + and other bee developers + + + + + + bee-query + 1 + + + + bee-query + Ask the bee database for files and packages + + + + + bee query + options + <pattern> + + + + + Description + + + Use bee-query to ask the bee database for + <pattern>. If + <pattern> matches the full name of an + installed package, all related files, otherwise all matching files and the + related packages will be displayed. + + + + + Options + + + + + + + Print a usage message. + + + + + + Environment + + + + + Directory searched for installed bee packages + + + + + + Bugs + + Please report bugs to bee-dev@googlegroups.com or directly to the authors. + + + + + See Also + + bee1, + bee-check1, + bee-download1, + bee-init1, + bee-install1, + bee-list1, + bee-remove1, + bee-update1 + + + diff --git a/manpages/bee-remove.xml b/manpages/bee-remove.xml new file mode 100644 index 0000000..f6cf559 --- /dev/null +++ b/manpages/bee-remove.xml @@ -0,0 +1,133 @@ + + + + + + + + bee - bau et einfach + bee @BEE_VERSION@ + + + + + Marius + Tolzmann + tolzmann@molgen.mpg.de + + + + + Tobias + Dreyer + dreyer@molgen.mpg.de + + + + + and other bee developers + + + + + + bee-remove + 1 + + + + bee-remove + Remove an installed bee package + + + + + bee remove + options + <bee-package> + + + + + Description + + + Use bee-remove to remove installed bee packages. + If <bee-package> does not match + the full name of a bee package, all matching packages will be displayed. + + + + + Options + + + + + + + Print a usage message. + + + + + + + Print removed files and directories. + + + + + + Environment + + + + + Directory searched for installed bee packages + + + + + + Bugs + + Please report bugs to bee-dev@googlegroups.com or directly to the authors. + + + + + See Also + + bee1, + bee-check1, + bee-download1, + bee-init1, + bee-install1, + bee-list1, + bee-query1, + bee-update1 + + + diff --git a/manpages/bee.xml b/manpages/bee.xml new file mode 100644 index 0000000..508f8d0 --- /dev/null +++ b/manpages/bee.xml @@ -0,0 +1,161 @@ + + + + + + + + bee - bau et einfach + bee @BEE_VERSION@ + + + + + Marius + Tolzmann + tolzmann@molgen.mpg.de + + + + + Tobias + Dreyer + dreyer@molgen.mpg.de + + + + + and other bee developers + + + + + + bee + 1 + + + + bee + Run a bee tool + + + + + bee + options + <tool> + tool-options + tool-arguments + + + + + Description + + + bee is a wrapper tool that is used to run all bee tools. + All options known by these bee tools can bee passed to bee. + + + + + Options + + + + + + + Run bee as if BEE_BEEDESTDIR + is your system's root directory. That means + BEE_BEEDESTDIR is prepended to + BEE_METADIR and BEE_CACHEDIR + and in case you run + bee-install1 + all files are extracted under BEE_BEEDESTDIR. + + + + + + + + Displays all bee relevant variables. + + + + + + + + Print a usage message. + + + + + + + Print bee's version. + + + + + + Environment + + + + + Directory searched for installed bee packages + + + + + Directory searched for available bee packages + + + + + + Bugs + + Please report bugs to bee-dev@googlegroups.com or directly to the authors. + + + + + See Also + + bee-check1, + bee-download1, + bee-init1, + bee-install1, + bee-list1, + bee-query1, + bee-remove1, + bee-update1 + + + From c12e7eae49d7f7213665288452b869d8a89e286d Mon Sep 17 00:00:00 2001 From: Matthias Ruester Date: Mon, 29 Apr 2013 14:49:40 +0200 Subject: [PATCH 3/5] manpages: add Makefile to generate man pages from xml files --- manpages/Makefile | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 manpages/Makefile diff --git a/manpages/Makefile b/manpages/Makefile new file mode 100644 index 0000000..1326e0d --- /dev/null +++ b/manpages/Makefile @@ -0,0 +1,32 @@ +quiet-command = $(if ${V},${1},$(if ${2},@echo ${2} && ${1}, @${1})) + +MANPAGES += bee +MANPAGES += bee-check +MANPAGES += bee-download +MANPAGES += bee-list +MANPAGES += bee-init +MANPAGES += bee-install +MANPAGES += bee-query +MANPAGES += bee-remove + +XMLTO = xmlto +XMLTO_FLAGS = --stringparam man.output.quietly=1 + +.PHONY: all +all: + @echo "Following targets are availabe:" + @echo " xml2man - update manpages" + +.PHONY: xml2man +xml2man: force-clean $(addsuffix .1.in,$(MANPAGES)) + +.PHONY: force-clean +force-clean: + $(call quiet-command,rm -f $(addsuffix .1.in,$(MANPAGES)),"CLEAN *.1.in") + $(call quiet-command,rm -f $(addsuffix .1, $(MANPAGES)),"CLEAN *.1") + +%.1: %.xml + $(call quiet-command,$(XMLTO) $(XMLTO_FLAGS) man $<,"XMLTO $<") + +%.1.in: %.1 + $(call quiet-command,mv $< $@,"RENAME $<") From e50efc2554fc362b635d36bdeabfb54a7ba2ed1d Mon Sep 17 00:00:00 2001 From: Matthias Ruester Date: Wed, 24 Apr 2013 12:08:39 +0200 Subject: [PATCH 4/5] manpages: update all man pages from xml files --- manpages/bee-check.1.in | 157 ++++++++++------------ manpages/bee-download.1.in | 169 ++++++++++++----------- manpages/bee-init.1.in | 266 ++++++++++++++++++------------------- manpages/bee-install.1.in | 192 +++++++++++++------------- manpages/bee-list.1.in | 187 +++++++++++++------------- manpages/bee-query.1.in | 139 +++++++++---------- manpages/bee-remove.1.in | 146 ++++++++++---------- manpages/bee.1.in | 177 ++++++++++++------------ 8 files changed, 691 insertions(+), 742 deletions(-) diff --git a/manpages/bee-check.1.in b/manpages/bee-check.1.in index 6fd11e3..83a0470 100644 --- a/manpages/bee-check.1.in +++ b/manpages/bee-check.1.in @@ -1,93 +1,82 @@ -." manpage of bee-check -." -." Copyright (C) 2009-2012 -." Marius Tolzmann -." Tobias Dreyer -." 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 . - -.TH "bee-check" "1" "2012-08-31" "bee @BEE_VERSION@" "bee - bau et einfach" - +'\" t +.\" Title: bee-check +.\" Author: Marius Tolzmann +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" 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 -.YS - +.HP \w'\fBbee\ check\fR\ 'u +\fBbee check\fR [options] \fI\fR .SH "DESCRIPTION" -.P -.B bee-check +.PP +\fBbee\-check\fR 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. - +\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 , -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 diff --git a/manpages/bee-download.1.in b/manpages/bee-download.1.in index 16b2907..4fad1bc 100644 --- a/manpages/bee-download.1.in +++ b/manpages/bee-download.1.in @@ -1,95 +1,90 @@ -." manpage of bee-download -." -." Copyright (C) 2009-2012 -." Marius Tolzmann -." Tobias Dreyer -." 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 . - -.TH "bee-download" "1" "2012-08-31" "bee @BEE_VERSION@" "bee - bau et einfach" - +'\" t +.\" Title: bee-download +.\" Author: Marius Tolzmann +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" 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 -.YS - +.HP \w'\fBbee\ download\fR\ 'u +\fBbee download\fR [options] \fI\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" " " -Specifiy the tarballs package name. -.TP -.BI "\-v, \-\-pkgversion" " " -Specifiy the tarballs package version. -.TP -.BI "\-c, \-\-commit" " " -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\fR\fR +.RS 4 +Specify the tarball\'s package name\&. +.RE +.PP +\fB\-v\fR, \fB\-\-pkgversion \fR\fB\fI\fR\fR +.RS 4 +Specify the tarball\'s package version\&. +.RE +.PP +\fB\-c\fR, \fB\-\-commit \fR\fB\fI\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 diff --git a/manpages/bee-init.1.in b/manpages/bee-init.1.in index 3d7953c..635b30f 100644 --- a/manpages/bee-init.1.in +++ b/manpages/bee-init.1.in @@ -1,149 +1,137 @@ -." manpage of bee-init -." -." Copyright (C) 2009-2012 -." Marius Tolzmann -." Tobias Dreyer -." 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 . - -.TH "bee-init" "1" "2012-08-31" "bee @BEE_VERSION@" "bee - bau et einfach" - +'\" t +.\" Title: bee-init +.\" Author: Marius Tolzmann +.\" Generator: DocBook XSL Stylesheets v1.75.2 +.\" Date: 04/24/2013 +.\" Manual: bee - bau et einfach +.\" Source: bee @BEE_VERSION@ +.\" Language: English +.\" +.TH "BEE\-INIT" "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\-init \- Create a bee file for building a bee package - +bee-init \- Create a bee file for building a bee package .SH "SYNOPSIS" -.SY "bee init" -.OP options -.I -.OP "-- configure options" -.YS - +.HP \w'\fBbee\ init\fR\ 'u +\fBbee init\fR [options] \fI\fR [\-\-\ configure\ options] .SH "DESCRIPTION" -.P -.B bee-init -is used to create a file, that is run in order to build a bee package. - +.PP +\fBbee\-init\fR +is used to create a file, that is run in order to build a bee package\&. .SH "OPTIONS" -.TP -.BI \-\-configure " " -Use the configure mode 'compat' if DATAROOTDIR is not supported in your build process. -.TP -.BI \-\-buildtype " " -Force buildtype: configure, cmake, make, autogen, perl-module, perl-module-makemaker, python-module -.TP -.B \-\-disable-versionify -Do not substitute version numbers in the source url. -.TP -.BI "\-t, \-\-template" "