add the man page for mbchk.

This commit is contained in:
okuji 1999-10-18 17:50:57 +00:00
parent 0f2f1a5cc4
commit e865376cd5
4 changed files with 97 additions and 12 deletions

View file

@ -1,3 +1,9 @@
1999-10-19 OKUJI Yoshinori <okuji@kuicr.kyoto-u.ac.jp>
* docs/Makefile.am (man_MANS): Added mbchk.1.
[MAINTAINER_MODE] (mbchk.1): New target.
* docs/mbchk.1: New file. Generated by help2man.
1999-10-18 OKUJI Yoshinori <okuji@kuicr.kyoto-u.ac.jp> 1999-10-18 OKUJI Yoshinori <okuji@kuicr.kyoto-u.ac.jp>
* Makefile.am (SUBDIRS): Added util. * Makefile.am (SUBDIRS): Added util.

View file

@ -1,7 +1,7 @@
info_TEXINFOS = grub.texi multiboot.texi info_TEXINFOS = grub.texi multiboot.texi
EXAMPLES = boot.S kernel.c multiboot.h EXAMPLES = boot.S kernel.c multiboot.h
multiboot_TEXINFOS = boot.S.texi kernel.c.texi multiboot.h.texi multiboot_TEXINFOS = boot.S.texi kernel.c.texi multiboot.h.texi
man_MANS = grub.8 man_MANS = grub.8 mbchk.1
HELP2MAN = help2man HELP2MAN = help2man
SRC2TEXI = src2texi SRC2TEXI = src2texi
noinst_SCRIPTS = $(HELP2MAN) $(SRC2TEXI) noinst_SCRIPTS = $(HELP2MAN) $(SRC2TEXI)
@ -32,4 +32,9 @@ if MAINTAINER_MODE
$(srcdir)/grub.8: ../grub/grub $(srcdir)/$(HELP2MAN) $(srcdir)/grub.8: ../grub/grub $(srcdir)/$(HELP2MAN)
$(PERL) $(srcdir)/$(HELP2MAN) --name="the grub shell" \ $(PERL) $(srcdir)/$(HELP2MAN) --name="the grub shell" \
--section=8 --output=$@ $< --section=8 --output=$@ $<
$(srcdir)/mbchk.1: ../util/mbchk $(srcdir)/$(HELP2MAN)
$(PERL) $(srcdir)/$(HELP2MAN) \
--name="check the format of a Multiboot kernel" \
--section=1 --output=$@ $<
endif endif

View file

@ -85,7 +85,7 @@ install_sh = @install_sh@
info_TEXINFOS = grub.texi multiboot.texi info_TEXINFOS = grub.texi multiboot.texi
EXAMPLES = boot.S kernel.c multiboot.h EXAMPLES = boot.S kernel.c multiboot.h
multiboot_TEXINFOS = boot.S.texi kernel.c.texi multiboot.h.texi multiboot_TEXINFOS = boot.S.texi kernel.c.texi multiboot.h.texi
man_MANS = grub.8 man_MANS = grub.8 mbchk.1
HELP2MAN = help2man HELP2MAN = help2man
SRC2TEXI = src2texi SRC2TEXI = src2texi
noinst_SCRIPTS = $(HELP2MAN) $(SRC2TEXI) noinst_SCRIPTS = $(HELP2MAN) $(SRC2TEXI)
@ -104,6 +104,7 @@ TEXI2DVI = texi2dvi
INFO_DEPS = grub.info multiboot.info INFO_DEPS = grub.info multiboot.info
DVIS = grub.dvi multiboot.dvi DVIS = grub.dvi multiboot.dvi
TEXINFOS = grub.texi multiboot.texi TEXINFOS = grub.texi multiboot.texi
man1dir = $(mandir)/man1
man8dir = $(mandir)/man8 man8dir = $(mandir)/man8
MANS = $(man_MANS) MANS = $(man_MANS)
@ -273,6 +274,41 @@ maintainer-clean-aminfo:
fi; \ fi; \
done done
install-man1:
$(mkinstalldirs) $(DESTDIR)$(man1dir)
@list='$(man1_MANS)'; \
l2='$(man_MANS)'; for i in $$l2; do \
case "$$i" in \
*.1*) list="$$list $$i" ;; \
esac; \
done; \
for i in $$list; do \
if test -f $(srcdir)/$$i; then file=$(srcdir)/$$i; \
else file=$$i; fi; \
ext=`echo $$i | sed -e 's/^.*\\.//'`; \
inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
inst=`echo $$inst | sed -e 's/^.*\///'`; \
inst=`echo $$inst | sed '$(transform)'`.$$ext; \
echo " $(INSTALL_DATA) $$file $(DESTDIR)$(man1dir)/$$inst"; \
$(INSTALL_DATA) $$file $(DESTDIR)$(man1dir)/$$inst; \
done
uninstall-man1:
@list='$(man1_MANS)'; \
l2='$(man_MANS)'; for i in $$l2; do \
case "$$i" in \
*.1*) list="$$list $$i" ;; \
esac; \
done; \
for i in $$list; do \
ext=`echo $$i | sed -e 's/^.*\\.//'`; \
inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
inst=`echo $$inst | sed -e 's/^.*\///'`; \
inst=`echo $$inst | sed '$(transform)'`.$$ext; \
echo " rm -f $(DESTDIR)$(man1dir)/$$inst"; \
rm -f $(DESTDIR)$(man1dir)/$$inst; \
done
install-man8: install-man8:
$(mkinstalldirs) $(DESTDIR)$(man8dir) $(mkinstalldirs) $(DESTDIR)$(man8dir)
@list='$(man8_MANS)'; \ @list='$(man8_MANS)'; \
@ -309,10 +345,10 @@ uninstall-man8:
done done
install-man: $(MANS) install-man: $(MANS)
@$(NORMAL_INSTALL) @$(NORMAL_INSTALL)
$(MAKE) $(AM_MAKEFLAGS) install-man8 $(MAKE) $(AM_MAKEFLAGS) install-man1 install-man8
uninstall-man: uninstall-man:
@$(NORMAL_UNINSTALL) @$(NORMAL_UNINSTALL)
$(MAKE) $(AM_MAKEFLAGS) uninstall-man8 $(MAKE) $(AM_MAKEFLAGS) uninstall-man1 uninstall-man8
tags: TAGS tags: TAGS
TAGS: TAGS:
@ -360,7 +396,8 @@ all-redirect: all-am
install-strip: install-strip:
$(MAKE) $(AM_MAKEFLAGS) INSTALL_STRIP_FLAG=-s install $(MAKE) $(AM_MAKEFLAGS) INSTALL_STRIP_FLAG=-s install
installdirs: installdirs:
$(mkinstalldirs) $(DESTDIR)$(infodir) $(DESTDIR)$(mandir)/man8 $(mkinstalldirs) $(DESTDIR)$(infodir) $(DESTDIR)$(mandir)/man1 \
$(DESTDIR)$(mandir)/man8
mostlyclean-generic: mostlyclean-generic:
@ -393,13 +430,13 @@ maintainer-clean: maintainer-clean-am
.PHONY: mostlyclean-vti distclean-vti clean-vti maintainer-clean-vti \ .PHONY: mostlyclean-vti distclean-vti clean-vti maintainer-clean-vti \
install-info-am uninstall-info mostlyclean-aminfo distclean-aminfo \ install-info-am uninstall-info mostlyclean-aminfo distclean-aminfo \
clean-aminfo maintainer-clean-aminfo install-man8 uninstall-man8 \ clean-aminfo maintainer-clean-aminfo install-man1 uninstall-man1 \
install-man uninstall-man tags distdir info-am info dvi-am dvi check \ install-man8 uninstall-man8 install-man uninstall-man tags distdir \
check-am installcheck-am installcheck install-exec-am install-exec \ info-am info dvi-am dvi check check-am installcheck-am installcheck \
install-data-am install-data install-am install uninstall-am uninstall \ install-exec-am install-exec install-data-am install-data install-am \
all-redirect all-am all install-strip installdirs mostlyclean-generic \ install uninstall-am uninstall all-redirect all-am all install-strip \
distclean-generic clean-generic maintainer-clean-generic clean \ installdirs mostlyclean-generic distclean-generic clean-generic \
mostlyclean distclean maintainer-clean maintainer-clean-generic clean mostlyclean distclean maintainer-clean
# Cancel the rule %.texi -> %. This rule may confuse make to determine # Cancel the rule %.texi -> %. This rule may confuse make to determine
@ -425,6 +462,10 @@ grub.info: grub.texi
@MAINTAINER_MODE_TRUE@ $(PERL) $(srcdir)/$(HELP2MAN) --name="the grub shell" \ @MAINTAINER_MODE_TRUE@ $(PERL) $(srcdir)/$(HELP2MAN) --name="the grub shell" \
@MAINTAINER_MODE_TRUE@ --section=8 --output=$@ $< @MAINTAINER_MODE_TRUE@ --section=8 --output=$@ $<
@MAINTAINER_MODE_TRUE@$(srcdir)/mbchk.1: ../util/mbchk $(srcdir)/$(HELP2MAN)
@MAINTAINER_MODE_TRUE@ $(PERL) $(srcdir)/$(HELP2MAN) --name="Multiboot format checker" \
@MAINTAINER_MODE_TRUE@ --section=1 --output=$@ $<
# Tell versions [3.59,3.63) of GNU make to not export all variables. # Tell versions [3.59,3.63) of GNU make to not export all variables.
# Otherwise a system limit (for SysV at least) may be exceeded. # Otherwise a system limit (for SysV at least) may be exceeded.
.NOEXPORT: .NOEXPORT:

33
docs/mbchk.1 Normal file
View file

@ -0,0 +1,33 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.013.
.TH MBCHK "1" "October 1999" "GNU GRUB 0.5.94" FSF
.SH NAME
mbchk \- Multiboot format checker
.SH SYNOPSIS
.B mbchk
[\fIOPTION\fR]... [\fIFILE\fR]...
.SH DESCRIPTION
.PP
Check if the format of FILE complies with the Multiboot Specification.
.TP
\fB\-q\fR, \fB\-\-quiet\fR
suppress all normal output
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help and exit
.TP
\fB\-v\fR, \fB\-\-version\fR
output version information and exit.
.SH "REPORTING BUGS"
Report bugs to <bug-grub@gnu.org>.
.SH "SEE ALSO"
The full documentation for
.B mbchk
is maintained as a Texinfo manual. If the
.B info
and
.B mbchk
programs are properly installed at your site, the command
.IP
.B info mbchk
.PP
should give you access to the complete manual.