util/mkelfImage/main/mkelfImage.man

   1 .\" Automatically generated by Pod::Man v1.3, Pod::Parser v1.13
   2 .\" But now manually maintained
   3 .\"
   4 .\" Standard preamble:
   5 .\" ========================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Vb \" Begin verbatim text
  19 .ft CW
  20 .nf
  21 .ne \\$1
  22 ..
  23 .de Ve \" End verbatim text
  24 .ft R
  25
  26 .fi
  27 ..
  28 .\" Set up some character translations and predefined strings.  \*(-- will
  29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  30 .\" double quote, and \*(R" will give a right double quote.  | will give a
  31 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  32 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  33 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  34 .tr \(*W-|\(bv\*(Tr
  35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  36 .ie n \{\
  37 .    ds -- \(*W-
  38 .    ds PI pi
  39 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  40 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  41 .    ds L" ""
  42 .    ds R" ""
  43 .    ds C` ""
  44 .    ds C' ""
  45 'br\}
  46 .el\{\
  47 .    ds -- \|\(em\|
  48 .    ds PI \(*p
  49 .    ds L" ``
  50 .    ds R" ''
  51 'br\}
  52 .\"
  53 .\" If the F register is turned on, we'll generate index entries on stderr for
  54 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  55 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  56 .\" output yourself in some meaningful fashion.
  57 .if \nF \{\
  58 .    de IX
  59 .    tm Index:\\$1\t\\n%\t"\\$2"
  60 ..
  61 .    nr % 0
  62 .    rr F
  63 .\}
  64 .\"
  65 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  66 .\" way too many mistakes in technical documents.
  67 .hy 0
  68 .if n .na
  69 .\"
  70 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  71 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  72 .    \" fudge factors for nroff and troff
  73 .if n \{\
  74 .    ds #H 0
  75 .    ds #V .8m
  76 .    ds #F .3m
  77 .    ds #[ \f1
  78 .    ds #] \fP
  79 .\}
  80 .if t \{\
  81 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  82 .    ds #V .6m
  83 .    ds #F 0
  84 .    ds #[ \&
  85 .    ds #] \&
  86 .\}
  87 .    \" simple accents for nroff and troff
  88 .if n \{\
  89 .    ds ' \&
  90 .    ds ` \&
  91 .    ds ^ \&
  92 .    ds , \&
  93 .    ds ~ ~
  94 .    ds /
  95 .\}
  96 .if t \{\
  97 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  98 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  99 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 100 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 101 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 102 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 103 .\}
 104 .    \" troff and (daisy-wheel) nroff accents
 105 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 106 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 107 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 108 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 109 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 110 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 111 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 112 .ds ae a\h'-(\w'a'u*4/10)'e
 113 .ds Ae A\h'-(\w'A'u*4/10)'E
 114 .    \" corrections for vroff
 115 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 116 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 117 .    \" for low resolution devices (crt and lpr)
 118 .if \n(.H>23 .if \n(.V>19 \
 119 \{\
 120 .    ds : e
 121 .    ds 8 ss
 122 .    ds o a
 123 .    ds d- d\h'-1'\(ga
 124 .    ds D- D\h'-1'\(hy
 125 .    ds th \o'bp'
 126 .    ds Th \o'LP'
 127 .    ds ae ae
 128 .    ds Ae AE
 129 .\}
 130 .rm #[ #] #H #V #F C
 131 .\" ========================================================================
 132 .\"
 133 .IX Title "MKELFIMAGE 8"
 134 .TH MKELFIMAGE 8 "RELEASE_DATE" "VERSION"
 135 .UC
 136 .SH "NAME"
 137 mkelfImage \- make an elf network bootable image for linux
 138 .SH "SYNOPSIS"
 139 .IX Header "SYNOPSIS"
 140 \&\fBmkelfImage\fR [\-\-command\-line=\fIcommand line\fR] [\-\-kernel=\fIpath to vmlinux\fR] [\-\-ramdisk=\fIpath to ramdisk\fR] [\-\-output=\fIfile\fR] [\-\-ramdisk\-base=<start addr>]
 141 .SH "DESCRIPTION"
 142 .IX Header "DESCRIPTION"
 143 \&\fBmkelfImage\fR is a program that makes a elf boot image for linux kernel
 144 images.  The image should work with any i386 multiboot compliant boot loader,
 145 an \s-1ELF\s0 bootloader that passes no options, a loader compliant with the linuxBIOS
 146 elf booting spec or with the linux kexec kernel patch.  A key feature
 147 here is that nothing relies upon \s-1BIOS\s0 calls, but they are made when
 148 necessary.  This is useful for systems running linuxbios.
 149 .SH "BUGS"
 150 .IX Header "BUGS"
 151 Not all kernel parameters can be passed with the multiboot image format.
 152 ip configuration is not automatically passed to a node.
 153 The ramdisk base is hard coded to 8MB by default.
 154 This man page need to be updated.
 155 .SH "SEE ALSO"
 156 .IX Header "SEE ALSO"
 157 The kexec kernel patch.
 158 LinuxBIOS.
 159 Etherboot.
 160 The multiboot standard.
 161 .SH "COPYRIGHT"
 162 .IX Header "COPYRIGHT"
 163 mkelfImage is under the \s-1GNU\s0 Public License version 2
 164 .SH "AUTHOR"
 165 .IX Header "AUTHOR"
 166 Eric Biederman <ebiederman@lnxi.com>