Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / elf2aout / elf2aout.1
blobaf6715fe7bffeb2c2a6810af45e7f24243bf2037
1 .\"     $NetBSD: elf2aout.1,v 1.8 2002/09/30 11:08:58 grant Exp $
2 .\"
3 .\" Copyright 1996 The Board of Trustees of The Leland Stanford
4 .\" Junior University. All Rights Reserved.
5 .\"
6 .\" Author: Jonathan Stone
7 .\"
8 .\" Permission to use, copy, modify, and distribute this
9 .\" software and its documentation for any purpose and without
10 .\" fee is hereby granted, provided that the above copyright
11 .\" notice and the above authorship notice appear in all copies.
12 .\" Stanford University makes no representations about the suitability
13 .\" of this software for any purpose.  It is provided "as is" without
14 .\" express or implied warranty.
15 .Dd September 30, 1996
16 .Dt ELF2AOUT 1
17 .Os
18 .Sh NAME
19 .Nm elf2aout
20 .Nd convert a NetBSD ELF-format executable to NetBSD a.out format
21 .Sh SYNOPSIS
22 .Nm elf2aout
23 .Ar elf-file
24 .Ar aout-file
25 .Sh DESCRIPTION
26 Reads a fully-linked ELF executable (such as a  linked kernel)
27 and produces an equivalent a.out format executable file.
28 .Pp
29 The
30 .Nm
31 utility is used to convert native
32 .Nx
33 ELF binaries
34 to a.out format, for compatibility with bootblocks and kernel-reading
35 utilities like
36 .Xr kvm 3
37 and
38 .Xr kvm_mkdb 8 ,
39 which currently expect an a.out format kernel.
40 .\" .Sh DIAGNOSTICS
41 .Sh SEE ALSO
42 .Xr elf2ecoff 1 ,
43 .Xr ld 1 ,
44 .Xr kvm 3 ,
45 .Xr a.out 5 ,
46 .Xr elf 5 ,
47 .Xr kvm_mkdb 8
48 .Sh HISTORY
49 .Nm
50 was originally developed for
51 .Nx Ns Tn /pmax
52 by Ted Lemon
53 and was first distributed with the pmax port of
54 .Nx 1.1 .
55 .Sh BUGS
56 .Nm
57 assumes there are no multiply-referenced symbols in the input ELF symbol
58 section.
59 It may be necessary to link with
60 .Fl x
61 to avoid such duplicate symbols.
62 .Pp
63 In some environments, the GNU binutils
64 .Xr objcopy 1
65 utility may be a better solution than
66 .Nm .