Name

msallinfo — Format output from the msrawinfo command

Synopsis

msallinfo [-project proj] [-hmR] [-s chr] MFDentry...

Description

The msallinfo command is a perl script that interfaces to the msrawinfo(1NCAR) command to produce formatted reports about MSS files and/or directories.

Note

The msallinfo perl script runs on the user's local system (i.e. the DCS Client system). If you have trouble running msallinfo, check that the path name of the perl interpreter on the first line of the file is correct, or make a symlink from /usr/local/bin/perl to the correct location.

Options

-p[roject] proj

Supply proj as the project number for charging. Currently, no charging is done for metadata operations, so this option is a placeholder for when charging might be imposed.

-h

Each MFDentry is the name of a virtual volume (also known as medium header). The msallinfo command will output information about each medium in the virtual volume. If the -R option is also selected, msallinfo will also output information about all files on each medium.

-m

Each MFDentry is the name of a storage medium. If the -R option is also selected, msallinfo will also output information about all files on each medium.

-R

Recursively get information for subdirectories (or other container objects) encountered.

-s chr

Set the split character to chr. The default is control-A (\x01). You may set chr to any character desired by specifying it directly or as a hexadecimal escape (in the form \xyy or \Xyy, where yy are two hexadecimal characters). Make sure to escape the backslash character from your shell, if necessary.

Operands

MFDentry

An MFDentry may be one of the following things:

  • An absolute or relative pathname of a directory or MSS file. If no path is given, the current MSS working directory is used.

  • The name of a virtual volume (also known as medium header).

  • The name of a storage medium.

Extended Description

The msallinfo script passes its arguments to the msrawinfo command for execution. The output of the msrawinfo command is then parsed to produce a readable report. See the msrawinfo(1NCAR) man page for details of the MFD field values.

Warning

The specific fields and their contents output by msrawinfo may be changed without prior notice.

The msallinfo script parses the HDR lines output by msrawinfo and dynamically builds the subroutines used to parse the lines describing the files and directories given as options. These subroutines are responsible for splitting the output of msrawinfo (at the split character) and assigning the values to the appropriate variable. Note that if the MSS filename or comment contains the split character, msallinfo will not work correctly. After splitting the line, the appropriate perl report format is selected and output is generated with the perl write function.

A different report may be generated by modifying the msallinfo format statements. Knowledge of the MFD record fields is likely to be required.

Environment Variables

See Environment Variables section of the Command Behavior and Envrionment chapter for details.

Exit Status

See Exit Status Codes section of the Command Behavior and Environment chapter for details.

See Also

msls(1NCAR), msrawinfo(1NCAR)

Copyright

2008 University Corporation for Atmospheric Research, all rights reserved.