#------------------------------------------------------------------------------ # # NSSDC/CDF CDFconvert online help. # # Version 1.1c, 21-Nov-97, Hughes STX. # # Modification history: # # V1.0 ?, J Love Original version. # V1.1 23-Sep-96, J Love CDF V2.6. # V1.1a 7-Jan-97, J Love Fixed cache qualifier. # V1.1b 21-Feb-97, J Love Removed RICE. # V1.1c 21-Nov-97, J Love Windows NT/95. # #------------------------------------------------------------------------------ #ifos mac win CDFconvert is used to convert one or more CDFs. Conversions can be from older releases of CDF (eg. Version 2.4 CDFs) to the current release and/or to change the format, majority, or encoding. The parameters/qualifiers dialog box displayed when CDFconvert is `executed' contains the following controls. Edit fields for... Source: The source CDF specification. This can be either a single CDF pathname or a folder/wildcard path in which case all CDFs which match the specification will be converted. Wildcards are allowed in the CDF name but not in the folder path. In either case, do not specify an extension. At the end of this field a button labeled "Select" is present. When selected, a standard input file dialog is displayed from which a single CDF may be selected. Destination: The destination of the converted CDF(s). This may be a single CDF pathname only if the source specification is a single CDF pathname. If the folder paths are the same, then a different CDF name must be specified. If more than one CDF is being converted, then this must be a folder path (other than the source folder path). This may also be a directory path if only one CDF is being converted. In any case, do not specify an extension. At the end of this field a button labeled "Select" is present. When selected, a standard output file dialog is displayed in which a single CDF may be specified. Skeleton: The pathname of a skeleton CDF to be used during the conversions (do not enter an extension). Specifying a skeleton CDF is optional. The skeleton CDF is used in the following cases... 1. If a format for the destination CDF(s) was not specified, then the format of the skeleton CDF will be used. 2. If a majority for the destination CDF(s) was not specified, then the majority of the skeleton CDF will be used. 3. If an encoding for the destination CDF(s) was not specified, then the encoding of the skeleton CDF will be used. Cache sizes: The number of 512-byte buffers to be used for the CDF's dotCDF file, staging file, and compression scratch file. If this field is left blank, default cache sizes chosen by the CDF library are used. The cache sizes are specified with a comma-separated list of pairs where is the number of cache buffers and is the type of file. The file 's are as follows: `d' for the dotCDF file, `s' for the staging file, and `c' for the compression scratch file. For example, `200d,100s' specifies 200 cache buffers for the dotCDF file and 100 cache buffers for the staging file. The dotCDF file cache size can also be specified without the `d' for compatibility with older CDF releases (eg. `200,100s'). Note that not all of the file types must be specified. Those not specified will receive a default cache size. Compression: Specifies the types of compression to be used for the CDF and/or variables. consists of a comma- separated list of the following... cdf: CDF's compression. vars: Compression for all variables. vars:: Compression for all variables with a blocking factor specified. vars::: Compression for all variables with a blocking factor and reserve percentage specified. var:: Compression for one particular variable. var::: Compression for one particular variable with a blocking factor specified. var:::: Compression for one particular variable with a blocking factor and reserve percentage specified. Where is one of the following: `none', `rle.0', `huff.0', `ahuff.0', or `gzip.'; is a blocking factor; is a reserve percentage; and is a delimited, case-sensitive variable name with the following syntax: ... For the `gzip' compression, must be in the range from `1' (fastest compression) to `9' (best compression). For compressions not specified the compression in the source CDF will be used. Specifying a variable compression using `var:' overrides a compression specified with `vars:'. Sparseness: Specifies the types of sparseness to be used for the variables. consists of a comma-separated list of the following... vars: Sparseness for all variables. var:: Sparseness for one particular variable. Where is one of the following: `srecords.no', `srecords.pad', or `srecords.prev'; and is a delimited, case-sensitive variable name with the following syntax: ... For sparsenesses not specified the sparseness in the source CDF will be used. Specifying a variable sparseness using `var:' overrides a sparseness specified with `vars:'. Check boxes for... Log progress: Whether or not progress messages are displayed. Display percentages: Whether or not the percentage of a variable's values converted is displayed during the conversion of that variable. Progress message logging must also be enabled. Delete existing: Whether or not an existing CDF is deleted if a new CDF with the same name is to be created. Page output: Whether or not the output is displayed one page (screen) at a time. Report info's: Whether or not informational status codes from the CDF library should be reported. Report warnings: Whether or not warning status codes from the CDF library should be reported. Report errors: Whether or not error status codes from the CDF library should be reported. -0.0 to 0.0: Whether or not -0.0 is converted to 0.0 by the CDF library when read from a CDF. Display statistics: Whether or not caching statistics are displayed at the end of each comparison of two CDFs. Radio buttons for... Format: The format of the destination CDF(s). Source...the same as the source CDF (unless a skeleton CDF was specified). Single...single-file. Multi....multi-file. Majority: The variable majority of the destination CDF(s). Source...the same as the source CDF (unless a skeleton CDF was specified). Row......row-major. Column...column-major. Encoding: The encoding of the destination CDF(s). Source.......the same as the source CDF (unless a skeleton CDF was specified). Host.........the host machine's encoding (ie., Macintosh encoding). Network......network encoding. Sun..........Sun encoding. VAX..........VAX encoding. SGi..........SGi encoding. HP...........HP encoding. IBM PC.......IBM PC encoding. IBM RS.......IBM RS encoding Macintosh....Macintosh encoding. DECstation...DECstation encoding. NeXT.........NeXT encoding. Alpha/VMSd...DEC Alpha/VMS D_FLOAT encoding. Alpha/VMSg...DEC Alpha/VMS G_FLOAT encoding. Alpha/OSF1...DEC Alpha/OSF1 encoding. zMode: The zMode to be used for the source CDF(s). 0...zMode is disabled. 1...zMode/1 should be used. The dimension variances of the rVariables will be preserved. 2...zMode/2 should be used. The dimensions of rVariables having a variance of NOVARY (false) are hidden. Buttons for... Enter Causes CDFconvert to convert CDF(s) based on the parameters/qualifiers specified. Help Causes this online help to be displayed. #ifos mac Quit Causes CDFconvert to terminate. (No CDFs are converted.) This button is only present the first time the parameters/qualifiers dialog box is displayed. #endos Cancel Causes the parameters/qualifiers dialog box to be closed. (No CDFs are converted.) #ifos mac This button is only present after the first time the parameters/qualifiers dialog box is displayed. #endos #else #ifos vms Usage: $ CDFCONVERT [/SKELETON=] [/[NO]LOG] [/[NO]PERCENT] [/REPORT=()] [/[NO]PAGE] [/CACHE=()] [/[NO]STATISTICS] [/ZMODE=] [/[NO]NEG2POSFP0] [/SINGLE | /MULTI] [/ROW | /COLUMN] [/HOST | /NETWORK | /ENCODING=] [/COMPRESSION=()] [/[NO]DELETE] [/SPARSENESS=()] #endos #ifos unix Usage: % cdfconvert [-skeleton ] [-[no]log] [-[no]percent] [-report ""] [-[no]page] [-cache ""] [-[no]statistics] [-zmode ] [-[no]neg2posfp0] [-single | -multi] [-row | -column] [-host | -network | -encoding ] [-compression ] [-[no]delete] [-sparseness ] #endos #ifos dos Usage: > cdfconvert [-skeleton ] [-[no]log] [-[no]percent] [-report ""] [-[no]page] [-cache ""] [-[no]statistics] [-zmode ] [-[no]neg2posfp0] [-single | -multi] [-row | -column] [-host | -network | -encoding ] [-compression ] [-[no]delete] [-sparseness ] #endos Purpose: CDFconvert is used to convert one or more CDFs. Conversions can be from older releases of CDF (eg. Version 2.4 CDFs) to the current release and/or to change the format, majority, or encoding. Parameter(s): The source CDF(s). This can be either a single CDF pathname or a directory/wildcard path in which case all CDFs which match the specification will be converted. Wildcards are allowed in the CDF name but not in the directory path. In either case, do not specify an extension. The destination of the converted CDF(s). This may be a single CDF pathname only if is a single CDF pathname. If the directory paths are the same, then a different CDF name must be specified. If more than one CDF is being converted, this must be a directory path (other than the source directory path). This may also be a directory path if only one CDF is being converted. In any case, do not specify an extension. #ifos vms Qualifier(s): /SKELETON= #else Qualifier(s): -skeleton #endos The pathname of a skeleton CDF to be used during the conversions (do not enter an extension). The skeleton CDF is used in the following cases. 1. If a format for the destination CDF(s) was not specified, then the format of the skeleton CDF will be used. 2. If a majority for the destination CDF(s) was not specified, then the majority of the skeleton CDF will be used. 3. If an encoding for the destination CDF(s) was not specified, then the encoding of the skeleton CDF will be used. Specifying a skeleton CDF is optional. #ifos vms /[NO]LOG #else -[no]log #endos Specifies whether or not messages are displayed indicating the progress of a conversion. #ifos vms /[NO]PERCENT #else -[no]percent #endos Specifies whether or not the percentage of a variable converted is displayed during the conversion of that variable. Message logging must also be enabled. #ifos vms /[NO]PAGE #else -[no]page #endos Specifies whether or not the output is displayed a page at a time. #ifos vms /ZMODE= #else -zmode #endos Specifies which zMode should be used with the source CDF(s). may be one of the following... 0 Indicates that zMode is disabled. 1 Indicates that zMode/1 should be used (the dimension variances of rVariables will be preserved). 2 Indicates that zMode/2 should be used (the dimensions of rVariables having a variance of NOVARY (false) are hidden. Note that using zMode/1 or zMode/2 on a source CDF which contains rVariables will produce a destination CDF containing only zVariables. The zMode "view" provided for the source CDF is written to the destination CDF during the conversion. #ifos vms /SINGLE | /MULTI #else -single | -multi #endos The format of the destination CDF(s). This overrides the format of the skeleton CDF (if specified). If neither this qualifier nor a skeleton CDF is specified, then the format of the destination CDF(s) will be the same as that of the source CDF(s). #ifos vms /ROW | /COLUMN #else -row | -column #endos The majority of the destination CDF(s). This overrides the majority of the skeleton CDF (if specified). If neither this qualifier nor a skeleton CDF is specified, then the majority of the destination CDF(s) will be the same as that of the source CDF(s). #ifos vms /HOST | /NETWORK | /ENCODING= #else -host | -network | -encoding #endos The encoding of the destination CDF(s). Specify only one of these qualifiers. This overrides the encoding of the skeleton CDF (if specified). If neither this qualifier nor a skeleton CDF is specified, then the encoding of a destination CDF will be the same as that of the source #ifos vms CDF. The possible values of are HOST, NETWORK, SUN, VAX, DECSTATION, SGi, IBMPC, IBMRS,, HP, NeXT, ALPHAOSF1, ALPHAVMSd, and ALPHAVMSg. Note that /HOST and /NETWORK are no longer necessary (but are supported for compatibility with previous CDF distributions). #else CDF. The possible values of are `host', `network', `sun', `vax', `decstation', `sgi', `ibmpc', `ibmrs', `mac', `hp', `next', `alphaosf1', `alphavmsd', and `alphavmsg'. Note that `-host' and `-network' are no longer necessary (but are supported for compatibility with previous CDF distributions). #endos #ifos vms /[NO]DELETE #else -[no]delete #endos Specifies whether or not an existing CDF is deleted if a new CDF with the same name is to be created. #ifos vms /[NO]NEG2POSFP0 #else -[no]neg2posfp0 #endos Specifies whether or not -0.0 is converted to 0.0 by the CDF library when read from or written to a CDF. -0.0 is an illegal floating point value on VAXes and DEC Alphas running OpenVMS. #ifos vms /REPORT=() #else -report "" #endos Specifies the types of return status codes from the CDF library which should be reported/displayed. is a comma-separated list of zero or more of the following symbols: `errors', `warnings', or `informationals'. Note these symbols can be truncated (eg. `e', `w', and `i'). #ifos vms /CACHE=() #else -cache "" #endos The number of 512-byte buffers to be used for the CDF's dotCDF file, staging file, and compression scratch file. If this qualifier is absent, default cache sizes chosen by the CDF library are used. The cache sizes are specified with a comma-separated list of pairs where is the number of cache buffers and is the type of file. The file 's are as follows: `d' for the dotCDF file, `s' for the staging file, and `c' for the compression scratch file. For example, `200d,100s' specifies 200 cache buffers for the dotCDF file and 100 cache buffers for the staging file. The dotCDF file cache size can also be specified without the `d' for compatibility with older CDF releases (eg. `200,100s'). Note that not all of the file types must be specified. Those not specified will receive a default cache size. #ifos vms /[NO]STATISTICS #else -[no]statistics #endos Specifies whether or not caching statistics are displayed at the end of each conversion. #ifos vms /COMPRESSION=() #else -compression "" #endos Specifies the types of compression to be used for the CDF and/or variables. The option consists of a comma- separated list of the following... cdf: CDF's compression. vars: Compression for all variables. vars:: Compression for all variables with a blocking factor specified. vars::: Compression for all variables with a blocking factor and reserve percentage specified. var:: Compression for one particular variable. var::: Compression for one particular variable with a blocking factor specified. var:::: Compression for one particular variable with a blocking factor and reserve percentage specified. Where is one of the following: `none', `rle.0', `huff.0', `ahuff.0', or `gzip.'; is a blocking factor; is a reserve percentage; and is a delimited, case-sensitive variable name with the following syntax: ... In general, do not use single or double quote marks as delimiters. But on VMS systems the entire delimited variable name must be enclosed in double quote marks (to preserve case-sensitivity). For the `gzip' compression, must be in the range from `1' (fastest compression) to `9' (best compression). For compressions not specified the compression in the source CDF will be used. Specifying a variable compression using `var:' overrides a compression specified with `vars:'. #ifos vms /SPARSENESS=() #else -sparseness "" #endos Specifies the types of sparseness to be used for the variables. The option consists of a comma- separated list of the following... vars: Sparseness for all variables. var:: Sparseness for one particular variable. Where is one of the following: `srecords.no', `srecords.pad', or `srecords.prev'; and is a delimited, case-sensitive variable name with the following syntax: ... In general, do not use single or double quote marks as delimiters. But on VMS systems the entire delimited variable name must be enclosed in double quote marks (to preserve case-sensitivity). For sparsenesses not specified the sparseness in the source CDF will be used. Specifying a variable sparseness using `var:' overrides a sparseness specified with `vars:'. #ifos vms Example(s): $ CDFCONVERT CDF$SMPL:TPLATE0 TEMPLATE0X/ENCODING=IBMPC $ CDFCONVERT/REPORT=(ERRORS) CDF$SMPL: USER_DISK:[USER.CDF] $ CDFCONVERT CAC_SST_BLENDED CAC_SST_BLENDEDX/SINGLE/NETWORK $ CDFCONVERT/SKELETON=CDF$SMPL:TPLATE3 CAC_SST_* [USER.CDF] $ CDFCONVERT FLUX1 FLUX2/COMPRESSION=(CDF:HUFF.0) $ CDFCONVERT/LOG MAG MAGX/COMPRESSION=(VAR:"^var1^":AHUFF.0:50) #endos #ifos unix Example(s): % cdfconvert ../samples/tplate0 template0x -encoding ibmpc % cdfconvert -report "errors" ../samples/ /disk4/user/cdf/ % cdfconvert cac_sst_blended cac_sst_1 -single -network % cdfconvert -skeleton tplate3 '../cdf/cac_sst_*' ~user/cdf % cdfconvert flux1 flux2 -compression "cdf:huff.0" % cdfconvert -log mag magx -compression "var:^var1^:ahuff.0:50" #endos #ifos dos Example(s): > cdfconvert ..\samples\tplate0 tplate0x -encoding ibmpc > cdfconvert -report "errors" ..\samples c:\disk4\user\cdf > cdfconvert cac_sst cac_sst1 -single -network > cdfconvert -skeleton tplate3 ..\cac_sst* b:\user\cdf > cdfconvert flux1 flux2 -compression "cdf:huff.0" > cdfconvert -log mag magx -compression "var:^var1^:ahuff.0:50" #endos #endos