MASM 6.1

CVPACK

The CVPACK utility reduces the size of an executable file that contains CodeView debugging information.

Syntax

CVPACK [[options]] exefile

Options

Option

Action

/HELP

Calls QuickHelp for help on CVPACK.

Packs the file to the smallest possible size.

Displays a summary of CVPACK command-line syntax.

EXEHDR

The EXEHDR utility displays and modifies the contents of an executable-file header.

Syntax

EXEHDR [[options]] filenames

Options

Option

Action

/HEA:number

Option name: /HEA[[P]]. Sets the heap allocation field to number bytes for segmented-executable files.

/HEL

Option name: /HEL[[P]]. Calls QuickHelp for help on EXEHDR.

/MA:number

Option name: /MA[[X]]. Sets the maximum memory allocation to number paragraphs for DOS executable files.

/MI:number

Option name: /MI[[N]]. Sets the minimum memory allocation to number paragraphs for DOS executable files.

/NE

Option name: /NE[[WFILES]]. Enables support for HPFS.

/NO

Option name: /NO[[LOGO]]. Suppresses the EXEHDR copyright message.

/PM:type

Option name: /PM[[TYPE]]. Sets the application type for Microsoft Windows®, where type is one of the following: PM (or WINDOWAPI), VIO (or WINDOWCOMPAT), or NOVIO (or NOTWINDOWCOMPAT).

Option name: /R[[ESETERROR]]. Clears the error bit in the header of a Windows executable file.

/S:number

Option name: /S[[TACK]]. Sets the stack allocation to number bytes.

Option

Action

Option name: /V[[ERBOSE]]. Provides more information about segmented-executable files, including the default flags in the segment table, all run-time relocations, and additional fields from the header.

Option name: /?. Displays a summary of EXEHDR command-line syntax.

EXP

The EXP utility deletes all files in the hidden DELETED subdirectory of the current or specified directory. EXP is used with RM and UNDEL to manage backup files.

Syntax

EXP [[options]] [[directories]]

Options

Option

Action

/HELP

Calls QuickHelp for help on EXP.

Suppresses display of deleted files.

Recurses into subdirectories of the current or specified directory.

Displays a summary of EXP command-line syntax.

HELPMAKE

The HELPMAKE utility creates help files and customizes the help files supplied with Microsoft language products.

Syntax

HELPMAKE {/E[[n]] | /D[[c]] | /H | /?} [[options]] sourcefiles

Options

Option

Action

/Ac

Specifies c as an application-specific control character for the help database, marking a line that contains special information for internal use by the application.

Indicates that the context strings are case sensitive so that at run time all searches for help topics are case sensitive.

Fully decodes the help database.

Option

Action

/DS

Splits the concatenated, compressed help database into its components, using their original names. No decompression occurs.

/DU

Decompresses the database and removes all screen formatting and cross-references.

/E[[n]]

Creates (“encodes”) a help database from a specified text file (or files). The optional n indicates the amount of compression to take place. The value of n can range from 0 to 15.

/H[[ELP]]

Calls the QuickHelp utility. If HELPMAKE cannot find QuickHelp or the help file, it displays a summary of HELPMAKE command-line syntax.

/Kfilename

Specifies a file containing word-separator characters. This file must contain a single line of characters that separate words. ASCII characters from 0 to 32 (including the space) and character 127 are always separators. If the /K option is not specified, the following characters are also considered separators: !”#&’()*+-,/:;<=>?@[\]^_`{\}~

Locks the generated file so that it cannot be decoded by HELPMAKE at a later time.

/NOLOGO

Suppresses the HELPMAKE copyright message.

/Ooutfile

Specifies outfile as the name of the help database. The name outfile is optional with the /D option.

/Sn

Specifies the type of input file, according to the following values for n:

/S1

Rich Text Format

/S2

QuickHelp Format

/S3

Minimally Formatted ASCII

During encoding, translates dot commands to application-specific commands. During decoding, translates application commands to dot commands. The /T option forces /A:.

/V[[n]]

Sets the verbosity of the diagnostic and informational output, depending on the value of n. The value of n can range from 0 to 6.

/Wwidth

Sets the fixed width of the resulting help text in number of characters. The value of width can range from 11 to 255.

Displays a summary of HELPMAKE command-line syntax.

H2INC

The H2INC utility converts C header (.H) files into MASM-compatible include (.INC) files. It translates declarations and prototypes, but does not translate code.

Syntax

H2INC [[options]] filename.H

Options

Option*

Action

Passes comments in the .H file to the .INC file.

/Fa[[filename]]

Specifies that the output file contain only equivalent MASM statements. This is the default.

/Fc[[filename]]

Specifies that the output file contain equivalent MASM statements plus original C statements converted to comment lines.

/HELP

Calls QuickHelp for help on H2INC.

/Ht

Enables generation of text equates. By default, text items are not translated.

/Mn

Instructs H2INC to explicitly declare the distances for all pointers and functions.

/Ni

Suppresses the expansion of nested include files.

/Zn string

Adds string to all names generated by H2INC. Used to eliminate name conflicts with other H2INC-generated include files.

/Zu

Makes all structure and union tag names unique.

Displays a summary of H2INC command-line syntax.

*H2INC also supports the following options from Microsoft C, version 6.0 and higher: /AC, /AH, /AL, /AM, /AS, /AT, /D, /F, /Fi, /G0, /G1, /G2, /G3, /G4, /Gc, /Gd, /Gr, /I, /J, /Tc, /U, /u, /W0, /W1, /W2, /W3, /W4, /X, /Za, /Zc, /Ze, /Zp1, /Zp2, /Zp4.

Environment Variables

Variable

Description

Specifies default command-line options.

H2INC

Specifies default command-line options. Appended after the CL environment variable.

INCLUDE

Specifies search path for include files.

IMPLIB

The IMPLIB utility creates import libraries used by LINK to link dynamic-link libraries with applications.

Syntax

IMPLIB [[options]] implibname {dllfile... | deffile...}

Options

Option

Action

Option name: /H[[ELP]]. Calls QuickHelp for help on IMPLIB.

/NOI

Option name: /NOI[[GNORECASE]]. Preserves case for entry names in DLLs.

/NOL

Option name: /NOL[[OGO]]. Suppresses the IMPLIB copyright message.

Option name: /?. Displays a summary of IMPLIB command-line syntax.

LIB

The LIB utility helps create, organize, and maintain run-time libraries.

Syntax

LIB inlibrary [[options]] [[commands]] [[, [[listfile]] [[, [[outlibrary]] ]] ]] [[;]]

Options

Option

Action

Option name: /H[[ELP]]. Calls QuickHelp for help on LIB.

Option name: /I[[GNORECASE]]. Tells LIB to ignore case when comparing symbols (the default). Use to combine a library marked /NOI with an unmarked library to create a new case-insensitive library.

/NOE

Option name: NOE[[XTDICTIONARY]]. Prevents LIB from creating an extended dictionary.

/NOI

Option name: /NOI[[GNORECASE]]. Tells LIB to preserve case when comparing symbols. When combining libraries, if any library is marked /NOI, the output library is case sensitive, unless /IGN is specified.

/NOL

Option name: /NOL[[OGO]]. Suppresses the LIB copyright message.

Option

Action

/P:number

Option name: /P[[AGESIZE]]. Specifies the page size (in bytes) of a new library or changes the page size of an existing library. The default for a new library is 16.

Option name: /?. Displays a summary of LIB command-line syntax.

Commands

Operator

Action

+name

Appends an object file or library file.

–name

Deletes a module.

–+name

Replaces a module by deleting it and appending an object file with the same name.

*name

Copies a module to a new object file.

–*name

Moves a module out of the library by copying it to a new object file and then deleting it.

LINK

The LINK utility combines object files into a single executable file or dynamic-link library.

Syntax

LINK objfiles [[, [[exefile]] [[, [[mapfile]] [[, [[libraries]] [[, [[deffile]] ]] ]] ]] ]] [[;]]

Options

Option

Action

/A:size

Option name: /A[[LIGNMENT]]. Directs LINK to align segment data in a segmented-executable file along the boundaries specified by size bytes, where size must be a power of two.

Option name: /B[[ATCH]]. Suppresses prompts for library or object files not found.

/CO

Option name: /CO[[DEVIEW]]. Adds symbolic data and line numbers needed by the Microsoft CodeView debugger. This option is incompatible with the /EXEPACK option.

/CP:number

Option name: /CP[[ARMAXALLOC]]. Sets the program’s maximum memory allocation to number of 16-byte paragraphs.

/DO

Option name: /DO[[SSEG]]. Orders segments in the default order used by Microsoft high-level languages.

Option

Action

/DS

Option name: /DS[[ALLOCATE]]. Directs LINK to load all data starting at the high end of the data segment. The /DSALLOC option is for assembly-language programs that create MS-DOS .EXE files.

Option name: /E[[XEPACK]]. Packs the executable file. The /EXEPACK option is incompatible with /INCR and /CO. Do not use /EXEPACK on a Windows-based application.

Option name: /F[[ARCALLTRANSLATION]]. Optimizes far calls. The /FARCALL option is automatically on when using /TINY. The /PACKC option is not recommended with /FARCALL when linking a Windows-based program.

/HE

Option name: /HE[[LP]]. Calls QuickHelp for help on LINK.

/HI

Option name: /HI[[GH]]. Places the executable file as high in memory as possible. Use /HIGH with the /DSALLOC option. This option is for assembly-language programs that create MS-DOS .EXE files.

/INC

Option name: /INC[[REMENTAL]]. Prepares for incremental linking with ILINK. This option is incompatible with /EXEPACK and /TINY.

/INF

Option name: /INF[[ORMATION]]. Displays to the standard output the phase of linking and names of object files being linked.

/LI

Option name: /LI[[NENUMBERS]]. Adds source file line numbers and associated addresses to the map file. The object file must be created with line numbers. This option creates a map file even if mapfile is not specified.

Option name: /M[[AP]]. Adds public symbols to the map file.

/NOD[[:libraryname]]

Option name: /NOD[[EFAULTLIBRARYSEARCH]]. Ignores the specified default library. Specify without libraryname to ignore all default libraries.

/NOE

Option name: /NOE[[XTDICTIONARY]]. Prevents LINK from searching extended dictionaries in libraries. Use /NOE when redefinition of a symbol causes error L2044.

/NOF

Option name: /NOF[[ARCALLTRANSLATION]]. Turns off far-call optimization.

/NOI

Option name: /NOI[[GNORECASE]]. Preserves case in identifiers.

/NOL

Option name: /NOL[[OGO]]. Suppresses the LINK copyright message.

Option

Action

/NON

Option name: /NON[[ULLSDOSSEG]]. Orders segments as with the /DOSSEG option, but with no additional bytes at the beginning of the _TEXT segment (if defined). This option overrides /DOSSEG.

/NOP

Option name: /NOP[[ACKCODE]]. Turns off code segment packing.

/PACKC[[:number]]

Option name: /PACKC[[ODE]]. Packs neighboring code segments together. Specify number bytes to set the maximum size for physical segments formed by /PACKC.

/PACKD[[:number]]

Option name: /PACKD[[ATA]]. Packs neighboring data segments together. Specify number bytes to set the maximum size for physical segments formed by /PACKD. This option is for Windows only.

/PAU

Option name: /PAU[[SE]]. Pauses during the link session for disk changes.

/PM:type

Option name: /PM[[TYPE]]. Specifies the type of Windows-based application where type is one
of the following: PM (or WINDOWAPI), VIO
(or WINDOWCOMPAT), or NOVIO
(or NOTWINDOWCOMPAT).

/ST:number

Option name: /ST[[ACK]]. Sets the stack size to number bytes, from 1 byte to 64K.

Option name: /T[[INY]]. Creates a tiny-model MS-DOS program with a .COM extension instead of .EXE. Incompatible with /INCR.

Option name: /?. Displays a summary of LINK command-line syntax.

Note

Several rarely used options not listed here are described in Help.

Environment Variables

Variable

Description

INIT

Specifies path for the TOOLS.INI file.

LIB

Specifies search path for library files.

LINK

Specifies default command-line options.

TMP

Specifies path for the VM.TMP file.

MASM

The MASM program converts command-line options from MASM style to ML style, adds options to maximize compatibility, and calls ML.EXE.

Note

MASM.EXE is provided to maintain compatibility with old makefiles. For new makefiles, use the more powerful ML driver.

Syntax

MASM [[options]] sourcefile [[, [[objectfile]] [[, [[listingfile]]
[[, [[crossreferencefile]] ]] ]] ]] [[;]]

Options

Option

Action

Orders segments alphabetically. Results in a warning. Ignored.

Sets internal buffer size. Ignored.

Creates a cross-reference file. Translated to /FR.

Creates a Pass 1 listing.Translated to F1/ST.

/Dsymbol[[=value]]

Defines a symbol. Unchanged.

Emulates floating-point instructions. Translated to /FPi.

Lists command-line arguments. Translated to /help.

/HELP

Calls QuickHelp for help on the MASM driver.

/I pathname

Specifies an include path. Unchanged.

Creates a normal listing. Translated to /Fl.

/LA

Lists all. Translated to /Fl and /Sa.

/ML

Treats names as case sensitive. Translated to /Cp.

/MU

Converts names to uppercase. Translated to /Cu.

/MX

Preserves case on nonlocal names. Translated to /Cx.

Suppresses table in listing file. Translated to /Sn.

Checks for impure code. Use OPTION READONLY. Ignored.

Orders segments sequentially. Results in a warning. Ignored.

Enables terse assembly. Translated to /NOLOGO.

Enables verbose assembly. Ignored.

Option

Action

/Wlevel

Sets warning level, where level = 0, 1, or 2.

Lists false conditionals. Translated to /Sx.

Displays error lines on screen. Ignored.

/ZD

Generates line numbers for CodeView. Translated to /Zd.

/ZI

Generates symbols for CodeView. Translated to /Zi.

Environment Variables

Variable

Description

INCLUDE

Specifies default path for .INC files.

MASM

Specifies default command-line options.

TMP

Specifies path for temporary files.

The ML program assembles and links one or more assembly-language source files. The command-line options are case sensitive.

Syntax

ML [[options]] filename [[ [[options]] filename]]... [[/link linkoptions]]

Options

Option

Action

/AT

Enables tiny-memory-model support. Enables error messages for code constructs that violate the requirements for .COM format files. Note that this is not equivalent to the .MODEL TINY directive.

/Bl filename

Selects an alternate linker.

Assembles only. Does not link.

/Cp

Preserves case of all user identifiers.

/Cu

Maps all identifiers to uppercase (default).

/Cx

Preserves case in public and extern symbols.

/Dsymbol[[=value]]

Defines a text macro with the given name. If value is missing, it is blank. Multiple tokens separated by spaces must be enclosed in quotation marks.

/EP

Generates a preprocessed source listing (sent to STDOUT). See /Sf.

/Fhexnum

Sets stack size to hexnum bytes (this is the same as /link /STACK:number). The value must be expressed in hexadecimal notation. There must be a space between /F and hexnum.

Option

Action

/Fefilename

Names the executable file.

/Fl[[filename]]

Generates an assembled code listing. See /Sf.

/Fm[[filename]]

Creates a linker map file.

/Fofilename

Names an object file.

/FPi

Generates emulator fixups for floating-point arithmetic (mixed-language only).

/Fr[[filename]]

Generates a Source Browser .SBR file.

/FR[[filename]]

Generates an extended form of a Source Browser .SBR file.

/Gc

Specifies use of FORTRAN- or Pascal-style function calling and naming conventions. Same as OPTION LANGUAGE:PASCAL.

/Gd

Specifies use of C-style function calling and naming conventions. Same as OPTION LANGUAGE:C.

/H number

Restricts external names to number significant characters. The default is 31 characters.

/help

Calls QuickHelp for help on ML.

/I pathname

Sets path for include file. A maximum of 10 /I options is allowed.

/nologo

Suppresses messages for successful assembly.

/Sa

Turns on listing of all available information.

/Sc

Adds instruction timings to listing file.

/Sf

Adds first-pass listing to listing file.

/Sg

Turns on listing of assembly-generated code.

/Sl width

Sets the line width of source listing in characters per line. Range is 60 to 255 or 0. Default is 0. Same as PAGE width.

/Sn

Turns off symbol table when producing a listing.

/Sp length

Sets the page length of source listing in lines per page. Range is 10 to 255 or 0. Default is 0. Same as PAGE length.

/Ss text

Specifies text for source listing. Same as SUBTITLE text.

/St text

Specifies title for source listing. Same as TITLE text.

/Sx

Turns on false conditionals in listing.

/Ta filename

Assembles source file whose name does not end with the .ASM extension.

Same as /W0.

/Wlevel

Sets the warning level, where level = 0, 1, 2, or 3.

Option

Action

/WX

Returns an error code if warnings are generated.

/Zd

Generates line-number information in object file.

/Zf

Makes all symbols public.

/Zi

Generates CodeView information in object file.

/Zm

Enables M510 option for maximum compatibility with MASM 5.1.

/Zp[[alignment]]

Packs structures on the specified byte boundary. The alignment may be 1, 2, or 4.

/Zs

Performs a syntax check only.

Displays a summary of ML command-line syntax.

QuickAssembler Support

For compatibility with QuickAssembler makefiles, ML recognizes these options:

Option

Action

Orders segments alphabetically in QuickAssembler. MASM 6.1 uses the .ALPHA directive for alphabetical ordering and ignores /a.

/Cl

Equivalent to /Cp.

/Ez

Prints the source for error lines to the screen. MASM 6.1 ignores this option.

/P1

Performs one-pass assembly. MASM 6.1 ignores this option.

/P2

Performs two-pass assembly. MASM 6.1 ignores this option.

Orders segments sequentially. MASM 6.1 uses the .SEQ directive for sequential ordering and ignores /s.

/Sq

Equivalent to /Sl0 /Sp0.

Environment Variables

Variable

Description

INCLUDE

Specifies search path for include files.

Specifies default command-line options.

TMP

Specifies path for temporary files.

NMAKE

The NMAKE utility automates the process of compiling and linking project files.

Syntax

NMAKE [[options]] [[macros]] [[targets]]

Options

Option

Action

Executes all commands even if targets are not out-of-date.

Suppresses the NMAKE copyright message and prevents nonfatal error or warning messages from being displayed.

Displays the modification time of each file when the times of targets and dependents are checked.

Causes environment variables to override macro definitions within description files.

/F filename

Specifies filename as the name of the description file to use. If a dash (–) is entered instead of a filename, NMAKE reads the description file from the standard input device. If /F is not specified, NMAKE uses MAKEFILE as the description file. If MAKEFILE does not exist, NMAKE builds command-line targets using inference rules.

/HELP

Calls QuickHelp for help on NMAKE.

Ignores exit codes from commands in the description file. NMAKE continues executing the rest of the description file despite the errors.

Displays but does not execute commands from the description file.

/NOLOGO

Suppresses the NMAKE copyright message.

Displays all macro definitions, inference rules, target descriptions, and the .SUFFIXES list.

Checks modification times of command-line targets (or first target in the description file if no command-line targets are specified). NMAKE returns a zero exit code if all such targets are up-to-date and a nonzero exit code if any target is out-of-date. Only preprocessing commands in the description file are executed.

Ignores inference rules and macros that are predefined or defined in the TOOLS.INI file.

Suppresses display of commands as they are executed.

Changes modification times of command-line targets (or first target in the description file if no command-line targets are specified) to the current time. Only preprocessing commands in the description file are executed. The contents of target files are not modified.

/X filename

Sends all error output to filename, which can be either a file or a device. If a dash (–) is entered instead of a filename, the error output is sent to the standard output device.

Internal option for use by the Microsoft Programmer’s WorkBench (PWB).

Displays a summary of NMAKE command-line syntax.

Environment Variable

Variable

Description

INIT

Specifies path for TOOLS.INI file, which may contain macros, inference rules, and description blocks.

PWB (Programmer’s WorkBench)

The Microsoft Programmer’s WorkBench (PWB) provides an integrated environment for developing programs in assembly language. The command-line options are case sensitive.

Syntax

PWB [[options]] [[files]]

Options

Option

Action

/D[[init]]

Prevents PWB from examining initialization files, where init is one or more of the following characters:

Disable autoload extensions (including language-specific extensions and Help).

Ignore CURRENT.STS.

Ignore TOOLS.INI.

If the /D option does not include an init character, it is equivalent to specifying /DAST (all files and extensions ignored).

/e cmdstr

Executes the command or sequence of commands at start-up. The entire cmdstr argument must be placed in double quotation marks if it contains a space. If cmdstr contains literal double quotation marks, place a backslash (\) in front of each double quotation mark. To include a literal backslash in the command string, use double backslashes (\\).

/m mark

Moves the cursor to the specified mark instead of moving it to the last known position. The mark can be a line number.

/P[[init]]

Specifies a program list for PWB to read, where init can be:

Ffile

Read a foreign program list (one not created using PWB).

Read the last program list. Use this option to start PWB in the same state you left it.

Pfile

Read a PWB program list.

Starts PWB in no-edit mode. Functions that modify files are disallowed.

Option

Action

[[/t]] file...

Loads the specified file at startup. The file specification can contain wildcards. If multiple files are specified, PWB loads only the first file. When the Exit function is invoked, PWB saves the current file and loads the next file in the list. Files specified with /t are temporary; PWB does not add them to the file history on the File menu.

No other options can follow /t on the command line. Each temporary file must be specified in a separate /t option.

Displays a summary of PWB command-line syntax.

Environment Variables

Variable

Description

HELPFILES

Specifies path of help files or list of help filenames.

INIT

Specifies path for TOOLS.INI and CURRENT.STS files.

TMP

Specifies path for temporary files.

PWBRMAKE

PWBRMAKE converts the .SBR files created by the assembler into database .BSC files that can be read by the Microsoft Programmer’s WorkBench (PWB) Source Browser. The command-line options are case sensitive.

Syntax

PWBRMAKE [[options]] sbrfiles

Options

Option

Action

/Ei filename
/Ei (filename...)

Excludes the contents of the specified include files from the database. To specify multiple filenames, separate them with spaces and enclose the list in parentheses.

/Em

Excludes symbols in the body of macros. Use /Em to include only macro names.

/Es

Excludes from the database every include file specified with an absolute path or found in an absolute path specified in the INCLUDE environment variable.

/HELP

Calls QuickHelp for help on PWBRMAKE.

/Iu

Includes unreferenced symbols.

Forces a nonincremental build and prevents truncation of .SBR files.

/o filename

Specifies a name for the database file.

Displays verbose output.

Displays a summary of PWBRMAKE command-line syntax.

QuickHelp

The QuickHelp utility displays Help files. All MASM reserved words and error messages can be used for topic.

Syntax

QH [[options]] [[topic]]

Options

Option

Action

/d filename

Specifies either a specific database name or a path where the databases are found.

/lnumber

Specifies the number of lines the QuickHelp window should occupy.

/mnumber

Changes the screen mode to display the specified number of lines, where number is in the range 25 to 60.

/p filename

Sets the name of the paste file.

/pa[[filename]]

Specifies that pasting operations are appended to the current paste file (rather than overwriting the file).

Prevents the version box from being displayed when QuickHelp is installed as a keyboard monitor.

/r command

Specifies the command that QuickHelp should execute when the right mouse button is pressed. The command can be one of the following letters:

Display last topic

Display history of help topics

Hide window

Display previous topic

Find next topic

Display contents

Specifies that clicking the mouse above or below the scroll box causes QuickHelp to scroll by lines rather than pages.

Option

Action

/t name

Directs QuickHelp to copy the specified section of the given topic to the current paste file and exit. The name may be:

All

Paste the entire topic

Syntax

Paste the syntax only

Example

Paste the example only

If the topic is not found, QuickHelp returns an exit code
of 1.

Specifies that QuickHelp is being run by a utility. If the topic specified on the command line is not found, QuickHelp immediately exits with an exit code of 3.

Environment Variables

Variable

Description

HELPFILES

Specifies path of help files or list of help filenames.

Specifies default command-line options.

TMP

Specifies directory of default paste file.

The RM utility moves a file to a hidden DELETED subdirectory of the directory containing the file. Use the UNDEL utility to recover the file and the EXP utility to mark the hidden file for deletion.

Syntax

RM [[options]] [[files]]

Options

Option

Action

Deletes read-only files without prompting.

/HELP

Calls QuickHelp for help on RM.

Inquires for permission before removing each file.

Keeps read-only files without prompting.

/R directory

Recurses into subdirectories of the specified directory.

Displays a summary of RM command-line syntax.

UNDEL

The UNDEL utility moves a file from a hidden DELETED subdirectory to the parent directory. UNDEL is used along with EXP and RM to manage backup files.

Syntax

UNDEL [[{option | files}]]

Options

Option

Action

/HELP

Calls QuickHelp for help on UNDEL.

Displays a summary of UNDEL command-line syntax.

Microsoft® CodeView® Debugger