From: Geoff Levand Date: Thu, 9 Jul 2009 17:40:44 +0000 (-0700) Subject: Add petitboot man pages X-Git-Tag: v1.0.0~831 X-Git-Url: https://git.ozlabs.org/?p=petitboot;a=commitdiff_plain;h=8ea63d7300d31d3c84f8977c45faf6470f841e92 Add petitboot man pages Signed-off-by: Geoff Levand --- diff --git a/Makefile.in b/Makefile.in index a1818d8..23135aa 100644 --- a/Makefile.in +++ b/Makefile.in @@ -39,5 +39,6 @@ localstatedir = @localstatedir@ builddir = @builddir@ srcdir = @srcdir@ top_srcdir = @top_srcdir@ +mandir = @mandir@ include $(top_srcdir)/rules.mk diff --git a/man/pb-cui.8 b/man/pb-cui.8 new file mode 100644 index 0000000..e671c20 --- /dev/null +++ b/man/pb-cui.8 @@ -0,0 +1,67 @@ +.\" Copyright (C) 2009 Sony Computer Entertainment Inc. +.\" Copyright 2009 Sony Corp. +.\" +.\" This program 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; version 2 of the License. +.\" +.\" This 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, write to the Free Software +.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +.\" +.\" Maintainer's Notes: +.\" * For syntax help see the man pages for 'mdoc' and 'mdoc.samples'. +.\" * To check syntax use this: +.\" 'groff -C -mtty-char -Tutf8 -man pb-cui.8'. +.\" * To check format use this: 'less pb-cui.8'. +.\" +.Dd "" +.Dt pb-cui 8 +.Os +.\" +.Sh NAME +.\" ==== +.Nm pb-cui +.Nd Petitboot ncurses bootloader UI +.\" +.Sh SYNOPSIS +.\" ======== +.Nm +.Op Fl h, -help +.Op Fl l, -log Ar log-file +.Op Fl V, -version +.\" +.Sh DESCRIPTION +.\" =========== +pb-cui is an ncurses based interface to the Petitboot bootloader. +.Pp +Petitboot is a Linux kexec based bootloader that supports loading Linux +kernel and initrd images from any device that can be mounted by Linux. +It can also load images from the network using the +HTTP, HTTPS, NFS, SFTP, and TFTP +protocols. +.\" +.Sh OPTIONS +.\" ======= +.Bl -tag -width indent +.\" +.It Fl h, -help +Print a help message. +.\" +.It Fl l, -log Ar log-file +Log messages to the file +.Ar log-file . +The default log is a file pb-cui.log in the directory where pb-cui +is started. New messages are appended to an existing log file. +.\" +.It Fl V, -version +Display the program version number. +.El +.Sh SEE ALSO +.\" ======== +.Xr petitboot 8 , Xr pb-discover 8 , Xr pb-event 8 diff --git a/man/pb-discover.8 b/man/pb-discover.8 new file mode 100644 index 0000000..9123e0f --- /dev/null +++ b/man/pb-discover.8 @@ -0,0 +1,44 @@ +.\" Copyright (C) 2009 Sony Computer Entertainment Inc. +.\" Copyright 2009 Sony Corp. +.\" +.\" This program 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; version 2 of the License. +.\" +.\" This 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, write to the Free Software +.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +.\" +.\" Maintainer's Notes: +.\" * For syntax help see the man pages for 'mdoc' and 'mdoc.samples'. +.\" * To check syntax use this: +.\" 'groff -C -mtty-char -Tutf8 -man pb-discover.8'. +.\" * To check format use this: 'less pb-discover.8'. +.\" +.Dd "" +.Dt pb-discover 8 +.Os +.\" +.Sh NAME +.\" ==== +.Nm pb-discover +.Nd The dynamic device discovery daemon of the Petitboot bootloader +.\" +.Sh SYNOPSIS +.\" ======== +.Nm +.\" +.Sh DESCRIPTION +.\" =========== +pb-discover maintains a dynamic list of boot options available to +the system. On startup, the petitboot user interface clients connect to +pb-discover daemon and receive boot option information. +.\" +.Sh SEE ALSO +.\" ======== +.Xr petitboot 8 , Xr pb-cui 8 , Xr pb-event 8 diff --git a/man/pb-event.8 b/man/pb-event.8 new file mode 100644 index 0000000..dc123e1 --- /dev/null +++ b/man/pb-event.8 @@ -0,0 +1,43 @@ +.\" Copyright (C) 2009 Sony Computer Entertainment Inc. +.\" Copyright 2009 Sony Corp. +.\" +.\" This program 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; version 2 of the License. +.\" +.\" This 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, write to the Free Software +.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +.\" +.\" Maintainer's Notes: +.\" * For syntax help see the man pages for 'mdoc' and 'mdoc.samples'. +.\" * To check syntax use this: +.\" 'groff -C -mtty-char -Tutf8 -man pb-event.8'. +.\" * To check format use this: 'less pb-event.8'. +.\" +.Dd "" +.Dt pb-event 8 +.Os +.\" +.Sh NAME +.\" ==== +.Nm pb-event +.Nd Event helper for the Petitboot bootloader +.\" +.Sh SYNOPSIS +.\" ======== +.Nm +.\" +.Sh DESCRIPTION +.\" =========== +The pb-event utility is used to send user mode events to pb-discover, the +petitboot device discovery daemon. +.\" +.Sh SEE ALSO +.\" ======== +.Xr petitboot 8 , Xr pb-cui 8 , Xr pb-discover 8 diff --git a/man/petitboot.8 b/man/petitboot.8 new file mode 100644 index 0000000..9dc2222 --- /dev/null +++ b/man/petitboot.8 @@ -0,0 +1,47 @@ +.\" Copyright (C) 2009 Sony Computer Entertainment Inc. +.\" Copyright 2009 Sony Corp. +.\" +.\" This program 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; version 2 of the License. +.\" +.\" This 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, write to the Free Software +.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +.\" +.\" Maintainer's Notes: +.\" * For syntax help see the man pages for 'mdoc' and 'mdoc.samples'. +.\" * To check syntax use this: +.\" 'groff -C -mtty-char -Tutf8 -man petitboot.8'. +.\" * To check format use this: 'less petitboot.8'. +.\" +.Dd "" +.Dt petitboot 8 +.Os +.\" +.Sh NAME +.\" ==== +.Nm petitboot +.Nd The Petitboot bootloader +.\" +.Sh DESCRIPTION +.\" =========== +Petitboot is a platform independent bootloader based on Linux kexec. +Petitboot can load Linux kernel and initrd images from any device that +can be mounted by Linux, and can also load images from the network +using the +HTTP, HTTPS, NFS, SFTP, and TFTP +protocols. +.Pp +Petitboot looks for bootloader configuration files on mountable devices +in the system, and can also be configured to use boot information +from a DHCP server. +.\" +.Sh SEE ALSO +.\" ======== +.Xr pb-cui 8 , Xr pb-discover 8 , Xr pb-event 8 diff --git a/rules.mk b/rules.mk index 436d033..aec0e90 100644 --- a/rules.mk +++ b/rules.mk @@ -29,6 +29,7 @@ endif # other to install artwork = background.jpg cdrom.png hdd.png usbpen.png tux.png cursor.gz +man8 = pb-cui.8 pb-discover.8 pb-event.8 petitboot.8 rules = utils/99-petitboot.rules udhcpc = utils/udhcpc @@ -129,6 +130,9 @@ install: all $(rules) $(udhcpc) $(INSTALL) -d $(DESTDIR)$(pkgdatadir)/utils $(INSTALL_DATA) $(top_srcdir)/$(rules) $(DESTDIR)$(pkgdatadir)/utils $(INSTALL_DATA) $(top_srcdir)/$(udhcpc) $(DESTDIR)$(pkgdatadir)/utils + $(INSTALL) -d $(DESTDIR)$(mandir)/man8/ + $(INSTALL_DATA) $(addprefix $(top_srcdir)/man/, $(man8)) \ + $(DESTDIR)$(mandir)/man8/ dist: $(PACKAGE)-$(VERSION).tar.gz