summaryrefslogtreecommitdiff
path: root/debian/manpages
diff options
context:
space:
mode:
Diffstat (limited to 'debian/manpages')
-rw-r--r--debian/manpages/ociobakelut.199
-rw-r--r--debian/manpages/ociocheck.135
-rw-r--r--debian/manpages/ocioconvert.128
-rw-r--r--debian/manpages/ociolutimage.143
4 files changed, 205 insertions, 0 deletions
diff --git a/debian/manpages/ociobakelut.1 b/debian/manpages/ociobakelut.1
new file mode 100644
index 0000000..8804c54
--- /dev/null
+++ b/debian/manpages/ociobakelut.1
@@ -0,0 +1,99 @@
+.TH OCIOBAKELUT 1
+.SH NAME
+ociobakelut \- create a new LUT or icc profile from an OCIO config or lut file(s)
+.SH SYNOPSIS
+.B ociobakelut
+.RI [ options ] " output-file" ...
+.SH DESCRIPTION
+This manual page documents briefly the
+.B ociobakelut
+command.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
+.\" respectively.
+\fBociobakelut\fP is a program which bakes a color transform into various color
+lookup file formats ("a LUT")
+.PP
+This is intended for applications that have not directly integrated
+OCIO, but can load LUT files
+.PP
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.BI "\-\-inputspace " space
+Input OCIO ColorSpace (or Role)
+.TP
+.BI "\-\-outputspace " space
+Output OCIO ColorSpace (or Role)
+.TP
+.BI "\-\-shaperspace " space
+the OCIO ColorSpace or Role, for the shaper
+.TP
+.BI "\-\-looks " looks
+the OCIO looks to apply
+.TP
+.BI "\-\-iconfig " configfile
+.PP
+Input .ocio configuration file (default: $OCIO)
+Config-Free LUT Baking
+.TP
+.BI "\-\-lut " lut
+Specify a LUT (forward direction)
+.TP
+.BI "\-\-invlut " lut
+Specify a LUT (inverse direction)
+.TP
+.BI "\-\-slope " "x y z"
+slope
+.TP
+.BI "\-\-offset " "x y z"
+offset (float)
+.TP
+.BI "\-\-offset10 " "x y z"
+offset (10-bit)
+.TP
+.BI "\-\-power " "x y z"
+power
+.TP
+.BI "\-\-sat " x
+saturation (ASC-CDL luma coefficients)
+.PP
+Baking options
+.TP
+.BI "\-\-format " format
+.TP
+.BI "\-\-shapersize ' n
+size of the shaper (default: format specific)
+.TP
+.BI "\-\-cubesize " n
+size of the cube (default: format specific)
+.TP
+.B "\-\-stdout"
+Write to stdout (rather than file)
+.PP
+ICC Options
+.TP
+.BI "\-\-whitepoint " n
+whitepoint for the profile (default: 6505)
+.BI "\-\-displayicc " s
+an icc profile which matches the OCIO profiles target display
+.BI "\-\-description " s
+a meaningful description, this will show up in UI like photoshop
+.BI "\-\-copyright " s
+a copyright field
+.PP
+other options
+.TP
+.B "\-\-v"
+Verbose
+.TP
+.B \-\-help
+Show summary of options.
+.TP
+.SH SEE ALSO
+.BR ociocheck (1),
+.BR ocioconvert (1),
+.BR ociolutimage (1).
+.br
+.B /usr/share/doc/opencolorio/OpenColorIO.pdf
diff --git a/debian/manpages/ociocheck.1 b/debian/manpages/ociocheck.1
new file mode 100644
index 0000000..2a17fff
--- /dev/null
+++ b/debian/manpages/ociocheck.1
@@ -0,0 +1,35 @@
+.TH OCIOCHECK 1
+.SH NAME
+ociocheck \- validate an OpenColorIO configuration
+.SH SYNOPSIS
+.B ociocheck
+.RI [ options ] " output-file" ...
+.SH DESCRIPTION
+This manual page documents briefly the
+.B ociocheck
+command.
+.PP
+\fBociocheck\fP validates the specified .ocio configuration,
+and checks that all the color transforms are defined.
+For example, it is possible that the configuration may reference
+lookup tables that do not exist. ociocheck will find these cases.
+
+ociocheck can also be used to clean up formatting on an existing profile
+that has been manually edited, using the '\-o' option.
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.BI "\-\-help " space
+print help message
+.TP
+.BI "\-\-iconfig " configfile
+Input .ocio configuration file (default: $OCIO)
+.TP
+.BI "\-\-oconfig " configfile
+Output .ocio file
+.SH SEE ALSO
+.BR ociobakelut (1),
+.BR ocioconvert (1),
+.BR ociolutimage (1).
+.br
+.B /usr/share/doc/opencolorio/OpenColorIO.pdf
diff --git a/debian/manpages/ocioconvert.1 b/debian/manpages/ocioconvert.1
new file mode 100644
index 0000000..e209caf
--- /dev/null
+++ b/debian/manpages/ocioconvert.1
@@ -0,0 +1,28 @@
+.TH OCIOCONVERT 1
+.SH NAME
+ocioconvert \- apply colorspace transform to an image
+.SH SYNOPSIS
+.B ocioconvert
+.RI [ options ] " output-file" ...
+.SH DESCRIPTION
+This manual page documents briefly the
+.B ocioconvert
+command.
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.TP
+.BI "\-\-float\-attribute " N=F
+name=float pair defining OCIO float atribute
+.TP
+.BI "\-\-int\-attribute " N=I
+name=int pair defining OCIO int atribute
+.TP
+.BI "\-\-string\-attribute " N=S
+name=string pair defining OCIO string atribute
+.SH SEE ALSO
+.BR ociobakelut (1),
+.BR ociocheck (1),
+.BR ociolutimage (1).
+.br
+.B /usr/share/doc/opencolorio/OpenColorIO.pdf
diff --git a/debian/manpages/ociolutimage.1 b/debian/manpages/ociolutimage.1
new file mode 100644
index 0000000..54100c6
--- /dev/null
+++ b/debian/manpages/ociolutimage.1
@@ -0,0 +1,43 @@
+.TH OCIOLUTIMAGE 1
+.SH NAME
+ociolutimage \- Convert a 3dlut to or from an image
+.SH SYNOPSIS
+.B ociolutimage
+.RI [ options ] " output-file" ...
+.SH DESCRIPTION
+This manual page documents briefly the
+.B ociolutimage
+command.
+.PP
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.BI \-\-generate
+Generate a lattice image
+.TP
+.BI \-\-extract
+Extract a 3dlut from an input image
+.TP
+.BI "\-\-input " file
+Specify the input filename
+.TP
+.BI "\-\-output " file
+Specify the output filename
+.TP
+.BI "\-\-cubesize " n
+Size of the cube (default: 32)
+.TP
+.BI "\-\-maxwidth " n
+Specify maximum width of the image (default: 2048)
+.TP
+.BI "\-\-config " file
+\&.ocio configuration file (default: $OCIO)
+.TP
+.BI "\-\-colorconvert " "in out"
+Apply a color space conversion to the image.
+.SH SEE ALSO
+.BR ociobakelut (1),
+.BR ocioconvert (1),
+.BR ocioconvert (1).
+.br
+.B /usr/share/doc/opencolorio/OpenColorIO.pdf