Manual Pages for UNIX Darwin command on man Rez

REZ(1) REZ(1)

NAME

Rez - compiles resources

SYNOPSIS

RReezz [ rezFile1 ] [ rezFile2 ] ...

[ -aalliiggnn wwoorrdd | lloonnggwwoorrdd ] [ -aa[ppppeenndd] ]

[ -aarrcchh architecture ] [ -cc[rreeaattoorr] creatorExpr ] [ -dd[eeffiinnee] macro [ =

data ] ]

[ -ii directoryPath ] [ -FF frameworkDirectoryPath ] [ -iiss[yyssrroooott]

sdkPath ] [ [ -mm[ooddiiffiiccaattiioonn] ]

[ -nnooRReessoollvvee [ oouuttppuutt | iinncclluuddee ] ] [ -oo outputFile ]

[ -oovv ] [ -pp[rrooggrreessss] ] [ -rrdd ] [ -rroo ]

[ -ss directoryPath ]

[ -ssccrriipptt RRoommaann | JJaappaanneessee | KKoorreeaann |

SSiimmppCChhiinneessee | TTrraaddCChhiinneessee ]

[ -tt[yyppee] typeExpr ] [ -uu[nnddeeff] macro ]

[ -uusseeDDFF ]

DESCRIPTION

The RReezz tool compiles the resource fork of a file according to the textual description contained in the resource description files. These resource description files must contain both the type declarations and the resource definitions needed to compile the resources. This data can come directly from the resource description files, as in this example:

Rez -F Carbon Carbon.r myResource.r

The data can also come from other text files that are included in

resource description files using ##iinncclluuddee and rreeaadd directives. For

example, mmyyRReessoouurrccee..rr could use ##iinncclluuddee to include the CCaarrbboonn..rr file.

IINNPPUUTT Standard input, unless you specify one or more resource description files. OOUUTTPPUUTT Normally RReezz writes the resource fork to the file RReezz..oouutt. You can

specify a different output file by using the -oo option. Errors and

warnings are written to diagnostic output. The RReezz tool does not write to standard output. AALLIIAASS RREESSOOLLUUTTIIOONN This command resolves Finder aliases in all input and output file specifications. This includes input source files, listing files, output

object files, paths specified with the -ii and -ss options, and paths

specified within source code using IINNCCLLUUDDEE or ##iinncclluuddee statements. This

behavior may be changed for resource files by using the -nnooRReessoollvvee

option. SSTTAATTUUSS RReezz can return the following status codes: 00 no errors 11 error in parameters 22 syntax error in resource description file 33 I/O or program error NNoottee If any errors are detected, RReezz sets the output file's modification date to 00,, which is January 1, 1904, 12:00 A.M. PPAARRAAMMEETTEERRSS rezFile1 [ rezFile2 ] ... Specifies one or more resource description files that contain type declarations and resource definitions. Typically this pairs a file containing only resource definitions with another containing only type declarations. The type declarations for the standard Macintosh resources are contained in the MMaaccTTyyppeess..rr file in the CarbonCore framework. You can also specify resource description files by using

##iinncclluuddee.. For example, a file containing only resource

definitions could include those containing the appropriate type declarations (for example, mmyyRReessoouurrccee..rr could include <>). In addition, you can also include resource files that have already been compiled by RReezz iinncclluuddee directive.

The -ssccrriipptt option enables RReezz to correctly process the 2- byte

character sets for foreign-language script systems.

OOPPTTIIOONNSS

-aalliiggnn wwoorrdd | lloonnggwwoorrdd

Aligns resources along word or longword boundaries. This allows the Resource Manager to load these resources faster. The RReezz

tool ignores this option if you use -aa[ppppeenndd].

-aa[ppppeenndd]

Appends new resources to the output file rather than replacing the output file. NNoottee The RReezz tool cannot append resources to a resource file that has

its read-only bit set. It also cannot replace a resource that

has its protected bit set unless you specify -oovv..

WWAARRNNIINNGG The RReezz tool overwrites any existing resource of the same type and ID without any warning message.

-aarrcchh architecture

A synonym for

-d architecture

If no -aarrcchh arguments are provided, RReezz automatically adds one

for the current system's architecture.

-cc[rreeaattoorr] creatorExpr

Sets the output file creator. (The default value is '????'.)

Note that creatorExpr is a Rez expression such as

-c "3*200+5"

If the creator begins with a letter and does not contain any spaces or special characters, you can simply type it in, as in this example:

-c APPL

Otherwise, you must format the creator as a numeric expression or as a literal expression such as

-c " '@@@@' "

-dd[eeffiinnee] macro [= data ]

Defines the macro variable macro as having the value data. You can use this option more than once on a command line. macro Specifies the macro variable to be defined. data Specifies the value of macro. This is the same as writing

#define macro [data]

at the beginning of the input. If you do not specify data, RReezz sets the value of data to the null string. Note that this still defines the macro.

-ii directoryPath

Directs RReezz to search this directory for ##iinncclluuddee files. You can

specify this option more than once. The RReezz tool searches directories in the order in which they appear on the command line.

-FF frameworkDirectoryPath

Directs RReezz to search this directory for frameworks referred to

by framework-style ##iinncclluuddee references (e.g. .)

By default, RReezz only searches the /System/Library/Frameworks directory; using this option you can specify other directories to be searched. You can specify this option more than once. The RReezz tool searches directories in the order in which they appear on the command line.

-iiss[yyssrroooott] sdkPath

Directs RReezz to search for included files and frameworks in the designated SDK. If omitted, the system root ("/") is assumed.

-mm[ooddiiffiiccaattiioonn]

Does not change the output file's modification date. If an error occurs, the output file's modification date is set to zero, even if you use this option. A date of 0 means January 1, 1904, 12:00 A.M.

-nnooRReessoollvvee [oouuttppuutt|iinncclluuddee]

Overrides the default alias resolution behavior by not resolving leaf aliases in the output resource file specification or in any included resource input files. oouuttppuutt If oouuttppuutt is specified, RReezz overrides the default Finder alias resolution behavior by not resolving leaf aliases in the output resource file specification. This allows you to modify a Finder alias file directly. iinncclluuddee

If iinncclluuddee is specified with -nnooRReessoollvvee then RReezz

overrides the default Finder alias resolution behavior by not resolving leaf aliases in any included resource input files. This allows you to iinncclluuddee resources directly from Finder alias files.

-oo outputFile

Places output in the specified output file. The default output file is RReezz..oouutt.

-oovv Overrides the protected bit when replacing resources with

-aa[ppppeenndd].

-pp[rrooggrreessss]

Writes version and progress information to diagnostic output.

-rrdd Suppresses warning messages for redeclared resource types.

-rroo Sets the mmaappRReeaaddOOnnllyy flag in the resource map.

-ss directoryPath

Directs RReezz to search this directory for resource iinncclluuddee files. You can specify this option more than once. The RReezz tool searches directories in the order in which they appear on the command line.

-ssccrriipptt RRoommaann | JJaappaanneessee | KKoorreeaann | SSiimmppCChhiinneessee | TTrraaddCChhiinneessee

Enables the recognition of any of several 2-byte character

script systems to use when compiling and decompiling files. This

option insures that 2-byte characters in strings are handled as

indivisible entities. The default language is RRoommaann and

specifies 1-byte character sets.

-tt[yyppee] typeExpr

Sets the type of the output file (the default is 'APPL'). Note that typeExpr is a RReezz expression, such as

-t "3*200+5"

If the type begins with a letter and does not contain any spaces or special characters, you can simply type it in, as in this example:

-t MPST

Otherwise, you must format it as a numeric expression or literal expression, such as

-t " '@@@@' "

-uu[nnddeeff] macro

Undefines the preset macro variable This is the same as writing

#undef macro

at the beginning of the input. This option can be repeated more than once on a command line.

-uusseeDDFF Reads and writes resource information from the files' data

forks, instead of their resource forks. EEXXAAMMPPLLEESS The following command line generates a resource fork for the file SSaammppllee, based on the type declarations and resource definitions in TTyyppeess..rr and SSaammppllee..rr: