Minor man page cleanups; update man page copyright
[wraplinux.git] / wraplinux.1
1 .\" -----------------------------------------------------------------------
2 .\"   
3 .\"   Copyright 2008 rPath, Inc. - All Rights Reserved
4 .\"   Copyright 2009 Intel Corporation  - All Rights Reserved
5 .\"
6 .\"   This program is free software; you can redistribute it and/or modify
7 .\"   it under the terms of the GNU General Public License as published by
8 .\"   the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
9 .\"   Boston MA 02110-1301, USA; either version 2 of the License, or
10 .\"   (at your option) any later version; incorporated herein by reference.
11 .\"
12 .\" -----------------------------------------------------------------------
13 .TH WRAPLINUX "1" "19 March 2009" "wraplinux" "H. Peter Anvin"
14 .SH NAME
15 wraplinux \- Create an ELF or NBI file from a Linux kernel with optional initrds.
16 .SH SYNOPSIS
17 .B wraplinux
18 [\fB\-EMNhV\fR][\fB-p\fR '\fIkernel parameters\fR'][\fB-i\fR \fIfilename\fR]...\ [\fB\-o\fR \fIoutput filename\fR] \fIkernel\fR
19 .SH DESCRIPTION
20 .PP
21 Takes a Linux kernel file and optional initrd files and outputs an ELF or NBI format file.
22 .SH OPTIONS
23 .TP
24 \fIkernel\fR
25 Kernel filename.
26 .TP
27 \fB\-i\fP \fIinitrd\fP, \fB\-\-initrd\fP \fIinitrd\fP
28 Initial ramdisk/ramfs filename. This option may occur multiple times.
29 .TP
30 \fB\-o\fP \fIfilename\fP, \fB\-\-output\fP \fIfilename\fP
31 Output filename (default stdout).
32 .TP
33 \fB\-p\fP '\fIkernel parameters\fP', \fB\-\-params\fP '\fIkernel parameters\fR'
34 Kernel commandline parameters (probably needs to be quoted.)
35 .TP
36 \fB\-E\fP, \fB\-\-elf\fP
37 Output in ELF format (default).
38 .TP
39 \fB\-M\fP, \fB\-\-multiboot\fP
40 Output in ELF format with a Multiboot header.
41 .TP
42 \fB\-N\fP, \fB\-\-NBI\fP
43 Output in NBI format.
44 .TP
45 \fB\-h\fP, \fB\-\-help\fP
46 Display a brief help message.
47 .TP
48 \fB\-V\fP, \fB\-\-version\fP
49 Print the program version.
50 .SH AUTHOR
51 Written by H. Peter Anvin <hpa@zytor.com>.
52 .SH COPYRIGHT
53 Copyright \(co 2008 rPath, Inc.
54 .br
55 Copyright \(co 2009 Intel Corporation
56 .br
57 This is free software; see the source for copying conditions.  There is NO
58 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.