man/man1/getinfo.1

.\" RCSid "$Id: getinfo.1,v 1.7 2016/08/30 06:10:12 greg Exp $"
.TH GETINFO 1 1/15/99 RADIANCE
.SH NAME
getinfo - get header information from a RADIANCE file
.SH SYNOPSIS
.B getinfo
[
.B -d
][
.B "file .."
]
.br
.B getinfo
[
.B -d
]
-
.br
.B getinfo
.B -a
.B "info_line1 .."
.br
.B getinfo
[
.B -d
]
.B -c
.B "command .."
.SH DESCRIPTION
.I Getinfo
reads the header of each RADIANCE
.I file
and writes it to the standard output.
Octree and picture files are in a binary format, which makes
it difficult to determine their content.
Therefore, a few lines of text are placed at the beginning
of each file by the RADIANCE program that creates it.
The end of the header information and the start of the
data is indicated by an empty line.
The
.I \-d
option can be used to print the dimensions of an octree or
picture file instead.
For an octree,
.I "getinfo \-d"
prints the bounding cube (xmin ymin zmin size).
For a picture,
.I "getinfo \-d"
prints the y and x resolution (\-Y yres +X xres).
If no
.I file
is given, the standard input is read.
.PP
The second form of
.I getinfo
with a hyphen simply removes the header
and copies the body of the file from the standard
input to the standard output.
If the
.I \-d
option is included, then the resolution string will be elided as well.
.PP
The third form of
.I "getinfo \-a"
adds one or more header lines to the standard input.
These lines are given as arguments to
.I getinfo,
and must be quoted if they contain spaces.
.PP
The fourth form of
.I "getinfo \-c"
is followed by a command and its arguments, which is executed
on the data segment of the standard input.
The header is passed along, with the addition of the command
at the end.
This is roughly equivalent to the following sequence, but does not
require the input to be in a file:
.IP "" .2i
( getinfo < input ; getinfo - < input | command .. )
.PP
If the
.I \-d
option is included, then the resolution string will be copied
before the command is called.
.SH EXAMPLE
To print the header information from scene1.oct and scene2.hdr:
.IP "" .2i
getinfo scene1.oct scene2.hdr
.SH AUTHOR
Greg Ward
.SH "SEE ALSO"
oconv(1), pfilt(1), rcalc(1), rhinfo(1), rpict(1), rsplit(1), rtrace(1), rvu(1)
Revision:	1.8
Committed:	Sat Jul 6 14:08:07 2019 UTC (6 years, 4 months ago) by greg
Branch:	MAIN
Changes since 1.7:	+16 -2 lines
Log Message:	Made getinfo -d option useful for header-skip ('-') and command ('-c') options
#	User	Rev	Content
1	greg	1.8	.\" RCSid "$Id: getinfo.1,v 1.7 2016/08/30 06:10:12 greg Exp $"
2	greg	1.1	.TH GETINFO 1 1/15/99 RADIANCE
3			.SH NAME
4			getinfo - get header information from a RADIANCE file
5			.SH SYNOPSIS
6			.B getinfo
7			[
8			.B -d
9			][
10			.B "file .."
11			]
12			.br
13			.B getinfo
14	greg	1.8	[
15			.B -d
16			]
17	greg	1.1	-
18	greg	1.6	.br
19			.B getinfo
20	greg	1.7	.B -a
21			.B "info_line1 .."
22			.br
23			.B getinfo
24	greg	1.8	[
25			.B -d
26			]
27	greg	1.6	.B -c
28			.B "command .."
29	greg	1.1	.SH DESCRIPTION
30			.I Getinfo
31			reads the header of each RADIANCE
32			.I file
33			and writes it to the standard output.
34			Octree and picture files are in a binary format, which makes
35			it difficult to determine their content.
36			Therefore, a few lines of text are placed at the beginning
37			of each file by the RADIANCE program that creates it.
38			The end of the header information and the start of the
39			data is indicated by an empty line.
40			The
41			.I \-d
42			option can be used to print the dimensions of an octree or
43			picture file instead.
44			For an octree,
45			.I "getinfo \-d"
46			prints the bounding cube (xmin ymin zmin size).
47			For a picture,
48			.I "getinfo \-d"
49	greg	1.4	prints the y and x resolution (\-Y yres +X xres).
50	greg	1.1	If no
51			.I file
52			is given, the standard input is read.
53			.PP
54	greg	1.6	The second form of
55			.I getinfo
56			with a hyphen simply removes the header
57	greg	1.1	and copies the body of the file from the standard
58			input to the standard output.
59	greg	1.8	If the
60			.I \-d
61			option is included, then the resolution string will be elided as well.
62	greg	1.6	.PP
63			The third form of
64	greg	1.7	.I "getinfo \-a"
65			adds one or more header lines to the standard input.
66			These lines are given as arguments to
67			.I getinfo,
68			and must be quoted if they contain spaces.
69			.PP
70			The fourth form of
71	greg	1.6	.I "getinfo \-c"
72			is followed by a command and its arguments, which is executed
73			on the data segment of the standard input.
74			The header is passed along, with the addition of the command
75			at the end.
76			This is roughly equivalent to the following sequence, but does not
77			require the input to be in a file:
78			.IP "" .2i
79			( getinfo < input ; getinfo - < input \| command .. )
80	greg	1.8	.PP
81			If the
82			.I \-d
83			option is included, then the resolution string will be copied
84			before the command is called.
85	greg	1.1	.SH EXAMPLE
86	greg	1.5	To print the header information from scene1.oct and scene2.hdr:
87	greg	1.1	.IP "" .2i
88	greg	1.5	getinfo scene1.oct scene2.hdr
89	greg	1.1	.SH AUTHOR
90			Greg Ward
91			.SH "SEE ALSO"
92	greg	1.8	oconv(1), pfilt(1), rcalc(1), rhinfo(1), rpict(1), rsplit(1), rtrace(1), rvu(1)