Document and rename the high load options
authorPaul Bolle <pebolle@tiscali.nl>
Fri, 28 May 2010 22:59:31 +0000 (00:59 +0200)
committerH. Peter Anvin <hpa@linux.intel.com>
Fri, 28 May 2010 23:02:23 +0000 (16:02 -0700)
Rename the high load options (to --load-high and --no-load-high).
Document these options too.

(Move the params option to the top in the man page, for consistency.)

Signed-off-by: Paul Bolle <pebolle@tiscali.nl>
Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
main.c
wraplinux.1

diff --git a/main.c b/main.c
index 568db4c..51413b5 100644 (file)
--- a/main.c
+++ b/main.c
@@ -36,18 +36,18 @@ enum longopts {
 };
 
 const struct option long_options[] = {
-       {"params",      1, 0, 'p'},
-       {"cmdline",     1, 0, 'p'},
-       {"commandline", 1, 0, 'p'},
-       {"initrd",      1, 0, 'i'},
-       {"output",      1, 0, 'o'},
-       {"loadhigh",    0, 0, 'l'},
-       {"noloadhigh",  0, 0,  OPT_NOLOADHIGH},
-       {"elf",         0, 0, 'E'},
-       {"multiboot",   0, 0, 'M'},
-       {"nbi",         0, 0, 'N'},
-       {"help",        0, 0, 'h'},
-       {"version",     0, 0, 'V'},
+       {"params",       1, 0, 'p'},
+       {"cmdline",      1, 0, 'p'},
+       {"commandline",  1, 0, 'p'},
+       {"initrd",       1, 0, 'i'},
+       {"output",       1, 0, 'o'},
+       {"load-high",    0, 0, 'l'},
+       {"no-load-high", 0, 0,  OPT_NOLOADHIGH},
+       {"elf",          0, 0, 'E'},
+       {"multiboot",    0, 0, 'M'},
+       {"nbi",          0, 0, 'N'},
+       {"help",         0, 0, 'h'},
+       {"version",      0, 0, 'V'},
        {0, 0, 0, 0}
 };
 
@@ -64,7 +64,8 @@ static void usage(int err)
                "  --elf          -E    output in ELF format (default)\n"
                "  --multiboot    -M    output in Multiboot ELF format\n"
                "  --nbi          -N    output in NBI format\n"
-               "  --loadhigh     -l    load entirely above 1 MB\n"
+               "  --load-high    -l    load entirely above 1 MB\n"
+               "                       (default for Multiboot ELF format)\n"
                "  --help         -h    display this help text\n"
                "  --version      -V    print the program version\n",
                WRAPLINUX_PACKAGE, WRAPLINUX_VERSION,
index 969a212..775a9b8 100644 (file)
@@ -15,7 +15,7 @@
 wraplinux \- Create an ELF or NBI file from a Linux kernel with optional initrds.
 .SH SYNOPSIS
 .B wraplinux
-[\fB\-EMNhV\fR][\fB-p\fR '\fIkernel parameters\fR'][\fB-i\fR \fIfilename\fR]...\ [\fB\-o\fR \fIoutput filename\fR] \fIkernel\fR
+[\fB\-EMNlhV\fR][\fB-p\fR '\fIkernel parameters\fR'][\fB-i\fR \fIfilename\fR]...\ [\fB\-o\fR \fIoutput filename\fR] \fIkernel\fR
 .SH DESCRIPTION
 .PP
 Takes a Linux kernel file and optional initrd files and outputs an ELF or NBI format file.
@@ -24,15 +24,15 @@ Takes a Linux kernel file and optional initrd files and outputs an ELF or NBI fo
 \fIkernel\fR
 Kernel filename.
 .TP
+\fB\-p\fP '\fIkernel parameters\fP', \fB\-\-params\fP '\fIkernel parameters\fR'
+Kernel commandline parameters (probably needs to be quoted.)
+.TP
 \fB\-i\fP \fIinitrd\fP, \fB\-\-initrd\fP \fIinitrd\fP
 Initial ramdisk/ramfs filename. This option may occur multiple times.
 .TP
 \fB\-o\fP \fIfilename\fP, \fB\-\-output\fP \fIfilename\fP
 Output filename (default stdout).
 .TP
-\fB\-p\fP '\fIkernel parameters\fP', \fB\-\-params\fP '\fIkernel parameters\fR'
-Kernel commandline parameters (probably needs to be quoted.)
-.TP
 \fB\-E\fP, \fB\-\-elf\fP
 Output in ELF format (default).
 .TP
@@ -42,6 +42,14 @@ Output in ELF format with a Multiboot header.
 \fB\-N\fP, \fB\-\-NBI\fP
 Output in NBI format.
 .TP
+\fB\-l\fP, \fB\-\-load-high\fP
+Load the Linux kernel and initrd files entirely above 1 MB (default for
+\-\-multiboot).
+.TP
+    \fB\-\-no-load-high\fP
+Overrule the default for \-\-multiboot (and load the Linux kernel and initrd
+files below and above 1 MB).
+.TP
 \fB\-h\fP, \fB\-\-help\fP
 Display a brief help message.
 .TP