]> git.ozlabs.org Git - petitboot/blobdiff - man/pb-nc.8
Cleanup man pages
[petitboot] / man / pb-nc.8
diff --git a/man/pb-nc.8 b/man/pb-nc.8
new file mode 100644 (file)
index 0000000..16ee654
--- /dev/null
@@ -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 <geoff @ infradead.org>