[BACK]Return to mkubootimage.1 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / usr.bin / mkubootimage

Annotation of src/usr.bin/mkubootimage/mkubootimage.1, Revision 1.2

1.2     ! wiz         1: .\"    $NetBSD: mkubootimage.1,v 1.1 2012/11/29 23:23:22 reed Exp $
1.1       reed        2: .\"
                      3: .\" Copyright (c) 2012 The NetBSD Foundation, Inc.
                      4: .\" All rights reserved.
                      5: .\"
                      6: .\" This code is derived from software contributed to The NetBSD Foundation
                      7: .\" by Jeremy C. Reed
                      8: .\"
                      9: .\" Redistribution and use in source and binary forms, with or without
                     10: .\" modification, are permitted provided that the following conditions
                     11: .\" are met:
                     12: .\" 1. Redistributions of source code must retain the above copyright
                     13: .\"    notice, this list of conditions and the following disclaimer.
                     14: .\" 2. Redistributions in binary form must reproduce the above copyright
                     15: .\"    notice, this list of conditions and the following disclaimer in the
                     16: .\"    documentation and/or other materials provided with the distribution.
                     17: .\"
                     18: .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
                     19: .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
                     20: .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
                     21: .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
                     22: .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
                     23: .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
                     24: .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
                     25: .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
                     26: .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
                     27: .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
                     28: .\" POSSIBILITY OF SUCH DAMAGE.
                     29: .\"
                     30: .Dd November 28, 2012
                     31: .Dt MKUBOOTIMAGE 1
                     32: .Os
                     33: .Sh NAME
                     34: .Nm mkubootimage
                     35: .Nd create U-Boot loader image
                     36: .Sh SYNOPSIS
                     37: .Nm
1.2     ! wiz        38: .Op Fl h
1.1       reed       39: .Fl A No ( arm Ns | Ns mips Ns | Ns mips64 Ns | Ns powerpc )
                     40: .Fl a Ar address
                     41: .Op Fl C No Po bz2 Ns | Ns gz Ns | Ns lzma Ns | Ns lzo Ns | Ns none Pc
                     42: .Op Fl E Ar address
                     43: .Op Fl e Ar address
                     44: .Op Fl m Ar magic
                     45: .Fl n Ar image
                     46: .Op Fl O No Po freebsd Ns | Ns linux Ns | Ns netbsd Ns | Ns openbsd Pc
                     47: .Fl T No ( fs Ns | Ns kernel Ns | Ns ramdisk Ns | Ns standalone )
                     48: .Ar source destination
                     49: .\"
                     50: .Sh DESCRIPTION
                     51: The
                     52: .Nm
                     53: utility is used to create an image for Das U-Boot, the
                     54: .Qq Universal Boot Loader .
                     55: .Pp
                     56: The arguments are as follows:
                     57: .Bl -tag -width indent
                     58: .It Fl A No ( arm Ns | Ns mips Ns | Ns mips64 Ns | Ns powerpc )
                     59: Defines the architecture.
                     60: This is required.
                     61: .It Fl a Ar address
                     62: Sets the image load address.
                     63: This is an integer between 0 and ULONG_MAX.
                     64: This is required.
1.2     ! wiz        65: .It Fl C No ( bz2 Ns | Ns gz Ns | Ns lzma Ns | Ns lzo Ns | Ns none )
1.1       reed       66: Defines the compression.
                     67: The default is
                     68: .Qq none .
                     69: .It Fl E Ar address
                     70: Define the entry point.
                     71: This is an integer between 0 and ULONG_MAX.
                     72: This option is the same as
                     73: .Fl e
                     74: but it inverts the bytes to convert the 32 bit integer
                     75: from little to big endian (or vice versa).
                     76: If
                     77: .Fl E
                     78: or
                     79: .Fl e
                     80: are not set, the entry point defaults to the
                     81: image load address
                     82: .Pq Fl a .
                     83: .It Fl e Ar address
                     84: Define the entry point.
                     85: This is an integer between 0 and ULONG_MAX.
                     86: If
                     87: .Fl E
                     88: or
                     89: .Fl e
                     90: are not set, the entry point defaults to the
                     91: image load address
                     92: .Pq Fl a .
                     93: .It Fl h
                     94: Display the usage and exit.
                     95: .It Fl m Ar magic
                     96: Set the magic.
                     97: This is an integer between 0 and ULONG_MAX.
                     98: The default is
1.2     ! wiz        99: .Qq 0x27051956 .
1.1       reed      100: .It Fl n Ar image
                    101: Defines the image name.
                    102: This is required.
                    103: .It Fl O No ( freebsd Ns | Ns linux Ns | Ns netbsd Ns | Ns openbsd )
                    104: Defines the operating system type.
                    105: The default OS name is
                    106: .Qq netbsd .
                    107: .It Fl T No ( fs Ns | Ns kernel Ns | Ns ramdisk Ns | Ns standalone )
                    108: Defines the image type.
                    109: This is required.
                    110: .El
                    111: .Pp
                    112: The required
                    113: .Ar source
                    114: argument is the filename of the kernel that is read.
                    115: The required
                    116: .Ar destination
                    117: argument is the filename of the image file that is created.
                    118: .\"
                    119: .Sh RETURN VALUES
                    120: .Nm
                    121: returns 1 on failure to read the kernel,
                    122: generate a header, or create the image.
                    123: .\"
                    124: .Sh EXAMPLES
                    125: Before the image is written, the header is displayed to standard out;
                    126: for example:
                    127: .Bd -literal -offset 0
                    128:  magic:       0x27051956
                    129:  time:        Tue Jun  7 15:58:41 2011
                    130:  size:        2482203
                    131:  load addr:   0x00020000
                    132:  entry point: 0x00020000
                    133:  data crc:    0x700fdf53
                    134:  os:          2 (netbsd)
                    135:  arch:        7 (powerpc)
                    136:  type:        2 (kernel)
                    137:  comp:        1 (gz)
                    138:  name:        NetBSD/evbppc 5.99.52 (INSTALL_PMPPC)
                    139:  header crc:  0x94ea96cf
                    140: .Ed
                    141: .\" TODO: check the name line above
                    142: .\" .Sh FILES
                    143: .Sh SEE ALSO
                    144: .Qq Das U-Boot - the Universal Boot Loader
                    145: .Pa http://www.denx.de/wiki/U-Boot/
                    146: .\"
                    147: .\" .Sh STANDARDS
                    148: .\"
                    149: .Sh HISTORY
                    150: The
                    151: .Nm
                    152: command first appeared in
                    153: .Nx 6.0 .
                    154: .\"
                    155: .Sh AUTHORS
                    156: The
                    157: .Nm
                    158: utility was originally written by Jared D. McNeill.
                    159: This manual page was written by Jeremy C. Reed.
                    160: .\" .Sh CAVEATS
                    161: .\" .Sh BUGS
                    162: .\" .Sh SECURITY CONSIDERATIONS

CVSweb <webmaster@jp.NetBSD.org>