From 561f7df61d193d63c07fe41e5612b243e928f336 Mon Sep 17 00:00:00 2001 From: Geoff Levand Date: Wed, 15 Feb 2012 14:54:50 -0800 Subject: Cleanup man pages Signed-off-by: Geoff Levand --- man/Makefile.am | 2 +- man/pb-cui.8 | 71 ------------------------------------------------------- man/pb-discover.8 | 2 +- man/pb-event.8 | 2 +- man/pb-nc.8 | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ man/pb-twin.8 | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++++ man/pb-udhcpc.8 | 38 +++++++++++++++++++++++++++++ man/petitboot.8 | 2 +- 8 files changed, 181 insertions(+), 75 deletions(-) delete mode 100644 man/pb-cui.8 create mode 100644 man/pb-nc.8 create mode 100644 man/pb-twin.8 create mode 100644 man/pb-udhcpc.8 (limited to 'man') diff --git a/man/Makefile.am b/man/Makefile.am index acba1fa..ed81c99 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -12,6 +12,6 @@ # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA # -dist_man_MANS = pb-cui.8 pb-discover.8 pb-event.8 petitboot.8 +dist_man_MANS = pb-discover.8 pb-event.8 pb-nc.8 pb-twin.8 pb-udhcpc.8 petitboot.8 MAINTAINERCLEANFILES = Makefile.in diff --git a/man/pb-cui.8 b/man/pb-cui.8 deleted file mode 100644 index fbe9b13..0000000 --- a/man/pb-cui.8 +++ /dev/null @@ -1,71 +0,0 @@ -.\" 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 -.\" -.Sh REPORTING BUGS -.\" ============== -Send bug reports to Geoff Levand diff --git a/man/pb-discover.8 b/man/pb-discover.8 index a9b6633..6b7be18 100644 --- a/man/pb-discover.8 +++ b/man/pb-discover.8 @@ -41,7 +41,7 @@ pb-discover daemon and receive boot option information. .\" .Sh SEE ALSO .\" ======== -.Xr petitboot 8 , Xr pb-cui 8 , Xr pb-event 8 +.Xr petitboot 8 , Xr pb-nc 8 , Xr pb-twin 8 , Xr pb-event 8 .\" .Sh REPORTING BUGS .\" ============== diff --git a/man/pb-event.8 b/man/pb-event.8 index d198b22..d762ace 100644 --- a/man/pb-event.8 +++ b/man/pb-event.8 @@ -40,7 +40,7 @@ petitboot device discovery daemon. .\" .Sh SEE ALSO .\" ======== -.Xr petitboot 8 , Xr pb-cui 8 , Xr pb-discover 8 +.Xr petitboot 8 , Xr pb-nc 8 , Xr pb-twin 8 , Xr pb-discover 8 .\" .Sh REPORTING BUGS .\" ============== diff --git a/man/pb-nc.8 b/man/pb-nc.8 new file mode 100644 index 0000000..16ee654 --- /dev/null +++ b/man/pb-nc.8 @@ -0,0 +1,71 @@ +.\" 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-nc.8'. +.\" * To check format use this: 'less pb-nc.8'. +.\" +.Dd "" +.Dt pb-nc 8 +.Os +.\" +.Sh NAME +.\" ==== +.Nm pb-nc +.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-nc 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-nc.log in the directory where pb-nc +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-twin 8 , Xr pb-discover 8 , Xr pb-event 8 +.\" +.Sh REPORTING BUGS +.\" ============== +Send bug reports to Geoff Levand diff --git a/man/pb-twin.8 b/man/pb-twin.8 new file mode 100644 index 0000000..fe4265c --- /dev/null +++ b/man/pb-twin.8 @@ -0,0 +1,68 @@ +.\" 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 +.\" +.Dd "" +.Dt pb-twin 8 +.Os +.\" +.Sh NAME +.\" ==== +.Nm pb-twin +.Nd Petitboot twin bootloader UI +.\" +.Sh SYNOPSIS +.\" ======== +.Nm +.Op Fl h, -help +.Op Fl l, -log Ar log-file +.Op Fl V, -version +.Op Fl V, -version +.Op Fl f, -fbdev +.Op Fl x, -x11 +.\" +.Sh DESCRIPTION +.\" =========== +pb-twin is a twin 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-twin.log in the directory where pb-twin +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-twin 8 , Xr pb-discover 8 , Xr pb-event 8 +.\" +.Sh REPORTING BUGS +.\" ============== +Send bug reports to Geoff Levand diff --git a/man/pb-udhcpc.8 b/man/pb-udhcpc.8 new file mode 100644 index 0000000..8a0eb6b --- /dev/null +++ b/man/pb-udhcpc.8 @@ -0,0 +1,38 @@ +.\" Copyright Geoff Levand +.\" +.\" 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 +.\" +.Dd "" +.Dt pb-udhcpc 8 +.Os +.\" +.Sh NAME +.\" ==== +.Nm pb-udhcpc +.Nd Petitboot udhcpc user script +.\" +.Sh DESCRIPTION +.\" =========== +Petitboot udhcpc user script. Should be run by udhcpc when +there is a change in the dhcp configuration. For more info +see the udhcpc man page and the Linux kernel source file +Documentation/filesystems/nfsroot.txt. +.\" +.Sh SEE ALSO +.\" ======== +.Xr petitboot 8 , Xr pb-nc 8 , Xr pb-twin 8 , Xr pb-discover 8 , Xr pb-event 8 +.\" +.Sh REPORTING BUGS +.\" ============== +Send bug reports to Geoff Levand diff --git a/man/petitboot.8 b/man/petitboot.8 index 653ee9d..8ace468 100644 --- a/man/petitboot.8 +++ b/man/petitboot.8 @@ -44,7 +44,7 @@ from a DHCP server. .\" .Sh SEE ALSO .\" ======== -.Xr pb-cui 8 , Xr pb-discover 8 , Xr pb-event 8 +.Xr pb-nc 8 , Xr pb-twin 8 , Xr pb-discover 8 , Xr pb-event 8 .\" .Sh REPORTING BUGS .\" ============== -- cgit v1.2.1