14.3 Command description format

In this chapter, the commands that can use parameter files are described on the premise that they use parameter files. The specification items that can be specified in both parameter files and command arguments are assumed to be specified in parameter files. For how to specify those specification items with the same content by using command arguments, see Command format without using any parameter file for individual commands.

In a parameter file for a command, write the parameters required to execute the command under different tags corresponding to the contents of parameters. To create a parameter file, first confirm the tags corresponding to the parameters to be set in the table for the specification contents of the parameter file. After that, check how to specify individual tags in 14.19.3 How to specify tags. For details about the types of tags, and parameter file format, see 14.19 Creating a parameter file.

If a specification item is specified in both a parameter file and a command argument, only the specification in the command argument is effective (the specification in the parameter file is ignored). Note, however, that, for the dcmpkget command, some items defined in the parameter file are effective, even when the same items are specified in both the parameter file and command arguments. For details about the dcmpkget command, see 14.10 dcmpkget.exe (making a backup of a package).

The following items are described for individual commands:

Function

Describes the function of a command.

Format

Shows the syntax of a command. An argument enclosed in brackets ([ ]) can be omitted. For commands that can use parameter files, the syntax is shown on the premise that parameter files are used.

Example of format

dcmXXXX.exe [/A] [/B]
             /i parameter-file-1 [parameter-file-2]

In this example of format, you can omit arguments other than /i parameter-file-1. Also, you can specify a maximum of two parameter files.

Arguments

Describes the arguments shown in Format. The arguments described here are those which cannot be specified in a parameter file.

Correspondence between the specification contents of parameter file and command arguments

Describes, in table format, the specification contents of the parameter file to be used for the command. The table also shows command arguments corresponding to parameters of parameter files that can be specified also as command arguments.

For details about parameters (and their defaults) that are specified in parameter files, see 14.19 Creating a parameter file. If a specification item is specified in both a parameter file and a command argument, only the specification in the command argument is effective, and the specification in the parameter file is ignored.

In the description of the command for which no parameter of the parameter file can be specified as a command argument, the title of this description item is replaced with Specification contents of parameter file.

Command format without using any parameter file

Shows the command format to be used when you do not use a parameter file but use only command arguments. The vertical bar (|) indicates that only one of the specification items separated by | can be specified.

Example of format

dcmXXXX.exe [/A|/B]
             /j job-name [/l path-name-of-job-storage-folder]

In this example of format, you can omit the arguments other than /j job-name. Also, you can specify /A or /B.

In the description of a command for which no parameter of the parameter file can be specified as a command argument, or the command that cannot use any parameter file, this description item is omitted.

Return codes

Describes the return codes that are output when a command is executed.

Note

Describes any points to be noted for a command.

Example

Describes how to execute a command with an actual example.

To Page Top