From patchwork Wed Jul 8 00:12:04 2009 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Geoff Levand X-Patchwork-Id: 29573 Return-Path: X-Original-To: patchwork-incoming@bilbo.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from ozlabs.org (ozlabs.org [203.10.76.45]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client CN "mx.ozlabs.org", Issuer "CA Cert Signing Authority" (verified OK)) by bilbo.ozlabs.org (Postfix) with ESMTPS id 2232EB7085 for ; Wed, 8 Jul 2009 10:25:38 +1000 (EST) Received: by ozlabs.org (Postfix) id 0A931DF3C7; Wed, 8 Jul 2009 10:21:48 +1000 (EST) Delivered-To: patchwork-incoming@ozlabs.org Received: from ozlabs.org (localhost [127.0.0.1]) by ozlabs.org (Postfix) with ESMTP id 06B86DDFF4 for ; Wed, 8 Jul 2009 10:21:48 +1000 (EST) X-Original-To: cbe-oss-dev@ozlabs.org Delivered-To: cbe-oss-dev@ozlabs.org Received: from hera.kernel.org (hera.kernel.org [140.211.167.34]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by ozlabs.org (Postfix) with ESMTPS id E76ADDDE06; Wed, 8 Jul 2009 10:18:33 +1000 (EST) Received: from hera.kernel.org (IDENT:U2FsdGVkX1+MuWjqduv+PO+aDTFbO3ETDNX9kirEOqM@localhost [127.0.0.1]) by hera.kernel.org (8.14.2/8.14.2) with ESMTP id n680IR3c026852 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Wed, 8 Jul 2009 00:18:27 GMT Received: (from geoff@localhost) by hera.kernel.org (8.14.2/8.13.1/Submit) id n680IR25026851; Wed, 8 Jul 2009 00:18:27 GMT Message-Id: <20090708001136.961874749@am.sony.com> User-Agent: quilt/0.47-1 Date: Tue, 07 Jul 2009 17:12:04 -0700 From: Geoff Levand To: Jeremy Kerr In-Reply-To: <20090708001134.934244536@am.sony.com> References: <20090708001134.934244536@am.sony.com> Content-Disposition: inline; filename=man-pages.diff X-Virus-Scanned: ClamAV 0.93.3/9541/Tue Jul 7 17:31:53 2009 on hera.kernel.org X-Virus-Status: Clean X-Spam-Status: No, score=-2.6 required=5.0 tests=AWL,BAYES_00, UNPARSEABLE_RELAY autolearn=ham version=3.2.5 X-Spam-Checker-Version: SpamAssassin 3.2.5 (2008-06-10) on hera.kernel.org X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.0 (hera.kernel.org [127.0.0.1]); Wed, 08 Jul 2009 00:18:28 +0000 (UTC) Cc: cbe-oss-dev@ozlabs.org Subject: [Cbe-oss-dev] [patch 30/31] petitboot: Add petitboot man pages X-BeenThere: cbe-oss-dev@ozlabs.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: Discussion about Open Source Software for the Cell Broadband Engine List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Sender: cbe-oss-dev-bounces+patchwork-incoming=ozlabs.org@ozlabs.org Errors-To: cbe-oss-dev-bounces+patchwork-incoming=ozlabs.org@ozlabs.org Signed-off-by: Geoff Levand --- Makefile.in | 1 man/pb-cui.8 | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ man/pb-discover.8 | 44 +++++++++++++++++++++++++++++++++++ man/pb-event.8 | 43 ++++++++++++++++++++++++++++++++++ man/petitboot.8 | 47 +++++++++++++++++++++++++++++++++++++ rules.mk | 4 +++ 6 files changed, 206 insertions(+) --- 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 --- /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 --- /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 --- /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 --- /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 --- 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 @@ -128,6 +129,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