external/gpl3/binutils/usr.sbin/mdsetimage/mdsetimage.8

   1 .\"     $NetBSD: mdsetimage.8,v 1.3 2010/11/07 11:50:23 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 1996 Christopher G. Demetriou
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" <<Id: LICENSE_GC,v 1.1 2001/10/01 23:24:05 cgd Exp>>
  29 .\"
  30 .Dd November 4, 2010
  31 .Dt MDSETIMAGE 8
  32 .Os
  33 .Sh NAME
  34 .Nm mdsetimage
  35 .Nd set kernel RAM disk image
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl svx
  39 .Op Fl b Ar bfdname
  40 .Op Fl I Ar image_symbol
  41 .Op Fl S Ar size_symbol
  42 .Ar kernel
  43 .Ar image
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 command copies the disk image specified by
  48 .Ar image
  49 into the memory disk storage area in
  50 .Ar kernel .
  51 The file system present in
  52 .Ar image
  53 will typically be used by the kernel
  54 as the root file system.
  55 .Pp
  56 To recognize kernel executable format, the
  57 .Fl b
  58 flag specifies BFD name of kernel.
  59 .Pp
  60 The
  61 .Fl I
  62 and
  63 .Fl S
  64 flags specify the symbol names of image and size of memory disk
  65 drivers respectively.
  66 .Pp
  67 If the
  68 .Fl s
  69 flags is given,
  70 .Nm
  71 will write back the actual disk image size back into
  72 .Ar kernel .
  73 .Pp
  74 If the
  75 .Fl v
  76 flag is given,
  77 .Nm
  78 will print out status information as
  79 it is copying the image.
  80 .Pp
  81 If the
  82 .Fl x
  83 flag is given,
  84 .Nm
  85 will extract the disk image from
  86 .Ar kernel
  87 into the file
  88 .Ar image .
  89 This is the opposite of the default behavior.
  90 .Sh SEE ALSO
  91 .Xr md 4 ,
  92 .Xr mdconfig 8