initial import
[profile/ivi/yasm.git] / yasm_objfmts.7
1 '\" t
2 .\"     Title: yasm_objfmts
3 .\"    Author: Peter Johnson <peter@tortall.net>
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
5 .\"      Date: February 2007
6 .\"    Manual: Yasm Supported Object Formats
7 .\"    Source: Yasm
8 .\"  Language: English
9 .\"
10 .TH "YASM_OBJFMTS" "7" "February 2007" "Yasm" "Yasm Supported Object Formats"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 yasm_objfmts \- Yasm Supported Object Formats
23 .SH "SYNOPSIS"
24 .HP \w'\fByasm\fR\ 'u
25 \fByasm\fR \fB\-f\ \fR\fB\fIobjfmt\fR\fR \fB\fI\&.\&.\&.\fR\fR
26 .SH "DESCRIPTION"
27 .PP
28 The standard Yasm distribution includes a number of modules for different object formats (Yasm\'s primary output)\&.
29 .PP
30 The object format is selected on the
31 \fByasm\fR(1)
32 command line by use of the
33 \fB\-f \fR\fB\fIobjfmt\fR\fR
34 command line option\&.
35 .SH "BIN"
36 .PP
37 The
38 \(lqbin\(rq
39 object format produces a flat\-format, non\-relocatable binary file\&. It is appropriate for producing DOS \&.COM executables or things like boot blocks\&. It supports only 3 sections and those sections are written in a predefined order to the output file\&.
40 .SH "COFF"
41 .PP
42 The COFF object format is an older relocatable object format used on older Unix and compatible systems, and also (more recently) on the DJGPP development system for DOS\&.
43 .SH "DBG"
44 .PP
45 The
46 \(lqdbg\(rq
47 object format is not a
48 \(lqreal\(rq
49 object format; the output file it creates simply describes the sequence of calls made to it by Yasm and the final object and symbol table information in a human\-readable text format (that in a normal object format would get processed into that object format\'s particular binary representation)\&. This object format is not intended for real use, but rather for debugging Yasm\'s internals\&.
50 .SH "ELF"
51 .PP
52 The ELF object format really comes in two flavors:
53 \(lqelf32\(rq
54 (for 32\-bit targets) and
55 \(lqelf64\(rq
56 (for 64\-bit targets)\&. ELF is a standard object format in common use on modern Unix and compatible systems (e\&.g\&. Linux, FreeBSD)\&. ELF has complex support for relocatable and shared objects\&.
57 .SH "MACHO"
58 .PP
59 The Mach\-O object format really comes in two flavors:
60 \(lqmacho32\(rq
61 (for 32\-bit targets) and
62 \(lqmacho64\(rq
63 (for 64\-bit targets)\&. Mach\-O is used as the object format on MacOS X\&. As Yasm currently only supports x86 and AMD64 instruction sets, it can only generate Mach\-O objects for Intel\-based Macs\&.
64 .SH "RDF"
65 .PP
66 The RDOFF2 object format is a simple multi\-section format originally designed for NASM\&. It supports segment references but not WRT references\&. It was designed primarily for simplicity and has minimalistic headers for ease of loading and linking\&. A complete toolchain (linker, librarian, and loader) is distributed with NASM\&.
67 .SH "WIN32"
68 .PP
69 The Win32 object format produces object files compatible with Microsoft compilers (such as Visual C++) that target the 32\-bit x86 Windows platform\&. The object format itself is an extended version of COFF\&.
70 .SH "WIN64"
71 .PP
72 The Win64 object format produces object files compatible with Microsoft compilers that target the 64\-bit
73 \(lqx64\(rq
74 Windows platform\&. This format is very similar to the win32 object format, but produces 64\-bit objects\&.
75 .SH "XDF"
76 .PP
77 The XDF object format is essentially a simplified version of COFF\&. It\'s a multi\-section relocatable format that supports 64\-bit physical and virtual addresses\&.
78 .SH "SEE ALSO"
79 .PP
80 \fByasm\fR(1),
81 \fByasm_arch\fR(7)
82 .SH "AUTHOR"
83 .PP
84 \fBPeter Johnson\fR <\&peter@tortall\&.net\&>
85 .RS 4
86 Author.
87 .RE
88 .SH "COPYRIGHT"
89 .br
90 Copyright \(co 2006 Peter Johnson
91 .br