Skip to content

Commit

Permalink
Merge branch 'manpages'
Browse files Browse the repository at this point in the history
* manpages:
  Update manpages in .gitignore
  manpages: update all man pages from xml files
  manpages: add Makefile to generate man pages from xml files
  manpages: add man pages in xml format
  Makefile: do not put man pages in the manpages subdirectory
  • Loading branch information
mariux committed May 13, 2013
2 parents 1393edc + 9668551 commit 05e648a
Show file tree
Hide file tree
Showing 19 changed files with 2,073 additions and 748 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@
/beelib.config.sh
/bee.1
/bee-check.1
/bee-download.1
/bee-init.1
/bee-install.1
/bee-list.1
/bee-query.1
/bee-remove.1
/bee-update.1
/beefind.sh
/bee-cache-inventory
/bee-cache-update.sh
Expand All @@ -32,7 +34,6 @@
/content2filelist.sh
/filelist2content.sh
/buildtypes/*.sh
/manpages/*.1
/.beerc
*.tar.gz
*.o
Expand Down
9 changes: 4 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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})
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down
32 changes: 32 additions & 0 deletions manpages/Makefile
Original file line number Diff line number Diff line change
@@ -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 $<")
157 changes: 73 additions & 84 deletions manpages/bee-check.1.in
Original file line number Diff line number Diff line change
@@ -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
Loading

0 comments on commit 05e648a

Please sign in to comment.