summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man1/sgitopnm.1
blob: 20167e267bd9f8d4b7cbf0190dbe8a8d89496bf7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
\
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
.\" Do not hand-hack it!  If you have bug fixes or improvements, please find
.\" the corresponding HTML page on the Netpbm website, generate a patch
.\" against that, and send it to the Netpbm maintainer.
.TH "Sgitopnm User Manual" 0 "25 April 2014" "netpbm documentation"

.SH NAME
sgitopnm - convert a SGI image file to PNM

.UN synopsis
.SH SYNOPSIS

\fBsgitopnm\fP

[\fB-verbose\fP]

[\fB-channel\fP \fIc\fP]

[\fISgiFileName\fP]


.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBsgitopnm\fP reads an SGI image file as input and produces a PGM
image for a 2-dimensional (1- or 2-channel) input file, and a PPM image for
a 3-dimensional (3 or more channels) input file.
.PP
Alternatively, the program produces a PGM image of any one of the
channels in the input file.
.PP
Before Netpbm 10.67 (June 2014), \fBsgitopnm\fP does not work on 2-channel
SGI images.  It fails if you try.
.PP
If you don't specify the \fISgiFileName\fP argument, input is from
Standard Input.
.PP
Before Netpbm 10.67 (June 2014), \fBsgitopnm\fP requires its input to
be a seekable file, so for example you can't feed it from a pipe.


.UN options
.SH OPTIONS
.PP
In addition to the options common to all programs based on libnetpbm
(most notably \fB-quiet\fP, see 
.UR index.html#commonoptions
 Common Options
.UE
\&), \fBsgitopnm\fP recognizes the following
command line options:


.TP
\fB-verbose\fP
Give some information about the SGI image file.

.TP
\fB-channel\fP \fIn\fP
Extract channel \fIn\fP of the image as a PGM image.
.sp
Without this option, \fBsgitopnm\fP extracts the first 3 channels as a PPM
image or, if the input has 1 or 2 channels, extracts the first channel as a
PGM image.
.sp
A 2-channel image is grayscale plus transparency, so you can get
the transparency information with \fB-channel=2\fP.  You could then
combine them into a PAM image of tuple type GRAYSCALE_ALPHA with
\fBpamstack\fP.



.UN references
.SH REFERENCES
.PP
The SGI image format specification version 1.0 is at
ftp://ftp.sgi.com/graphics/grafica/sgiimage.html .
.PP
There is an example SGI file at 
https://github.com/ZaaLabs/ZaaIL-TestImages/tree/master/SGI .


.UN seealso
.SH SEE ALSO
.BR "pnm" (1)\c
\&,
.BR "pam" (1)\c
\&,
.BR "pnmtosgi" (1)\c
\&,
.BR "pamstack" (1)\c
\&


.UN author
.SH AUTHOR
.PP
Copyright (C) 1994 by Ingo Wilken
(\fI
Ingo.Wilken@informatik.uni-oldenburg.de\fP)
.SH DOCUMENT SOURCE
This manual page was generated by the Netpbm tool 'makeman' from HTML
source.  The master documentation is at
.IP
.B http://netpbm.sourceforge.net/doc/sgitopnm.html
.PP