1
.TH HDFED 1 "October 31, 1999"
2
.\" man page by Jim Van Zandt <jrv@vanzandt.mv.com> -*- nroff -*-
4
hdfed \- edit the contents of an HDF File
11
\fBhdfed\fP allows experienced HDF users to manipulate the
12
elements of an HDF file. These manipulations include
14
Selecting groups and showing information about them.
16
Dumping group information to output files.
18
Writing group data to output files.
20
Deleting groups from HDF files.
22
Inserting groups in HDF files.
24
Replacing elements of HDF files.
26
Editing the labels and descriptions of any element in an HDF file.
28
\fBhdfed\fP is designed primarily for users who need to know about HDF
29
files at the level of individual data elements. It is not designed to
30
provide a comprehensive high-level view of the contents of an HDF file
31
- other tools and utilities should be used for that purpose. To use
32
\fBhdfed\fP one should be familiar with the components of an HDF file
33
covered in the HDF Specifications manual.
35
The \fBhdfed\fP utility is loosely modeled on ed(1), the UNIX line
36
editor. When \fBhdfed\fP is invoked, it prompts the user for commands,
37
as does ed. Also, basic command syntax and description information is
38
available to the user through \fBhdfed\fP. The most common \fBhdfed\fP
39
commands are used to control the position in the HDF file and the
40
format of the information provided.
42
The initial view of the file under \fBhdfed\fP consists of a set of
43
tag/reference number pairs. Although \fBhdfed\fP allows modification
44
of tags and reference numbers within strict constraints, it will not
45
allow the user to arbitrarily modify binary data in the file.
47
The following terms and concepts must be understood in order to use
48
\fBhdfed\fP correctly and will be used in the following discussion
51
The data object or object refers to an HDF data object and the
52
data descriptor of that object. (i.e., tags, reference numbers,
55
The data or data element refers to the record that the data descriptor
56
points to. For a precise definition of the data that is associated
57
with a given tag consult the HDF Specifications and Developer's Guide
58
v3.2 from the HDF WWW home page at http://hdf.ncsa.uiuc.edu/.
60
The group refers to a predefined collection of data objects that
61
correspond to a particular application. For example, a raster image
62
group refers to the collection of objects that are used to store all
63
of the information in a raster image set.
65
Once an HDF file has been opened by \fBhdfed\fP, the following operations
66
can be performed on the data file, among others:
68
Select an HDF object to examine more closely.
70
Move forward or backward within the HDF file.
72
Get information about an object. (tag, reference number, size,
75
Display a raster image using the ICR protocol.
77
Display the contents of any object.
81
Annotate an object with a label or description.
83
Write an object to a second HDF file.
85
Write data elements in binary form to a non-HDF file.
87
Close the file and exit, or open a new file.
89
\fBhdfed\fP commands are documented in the Users Guide section on
90
Command-line Utilities.
94
Make no backup file. If this option is omitted, a backup file is
95
automatically created.
98
Input to \fBhdfed\fP is a stream of \fBhdfed\fP commands, rather than
99
interactively. The \fB-batch\fP flag is useful when a group of
100
commonly-used commands are included in a UNIX shell script. The
101
following is an example of such a script, using the C-shell, that
102
lists information about the groups in a specified HDF file.
108
hdfed -batch $file -nobackup << EOF
117
Output usage information, as well as a quick list of the \fBhdfed\fPj
122
The HDF Users Guide: \fI/usr/share/doc/libhdf4g/html-userguide/Utils2.html#33\fP.