cif.1

.Dd Oct 26, 2021
.Dt CIF 1
.Os POSIX systems


.Sh NAME
.Nm cif
.Nd creates and modifies cif files


.Sh SYNOPSIS
.Nm cif
.Fl h|a|l|d
.Op Fl c
.Op Fl t Ar image_type
.Op Fl v
.Ar cif file
.Op Ar image ...


.Sh DESCRIPTION
.Nm
creates and modifies cif files. It can only perform one operation at a time on a
file. 

The operations are as follows:
.Bl -tag -width Ds
.It Fl h
Show a help message
.It Fl a
Append images to the cif file. It reads the .png images specified after the cif
file and converts them into the cif format.
.Nm
selects the base file name without extension as the name of the cif file and
gives the user a prompt to select the image type
.It Fl l
List the contents of the cif file. It will be displayed in the following format:

Name
.D1 Image type
.D1 Image format
.D1 width and height
.D1 Mipmap Level:
.D1 Size:
.It Fl d
Delete images by name from the cif file. The arguments behind the cif file have
to be the exact name of the image in the cif file that should be deleted
.El

The optional arguments are as follows:
.Bl -tag -width Ds
.It Fl c
Compress newly added images
.It Fl t Ar image_type
Don't interactively ask what image type the image is and set the type to the number specified with
.Ar image_type
 
Possible types are:
.Bl -bullet -compact
.It
Albedo (normal): 0
.It
Roughness map: 1
.It
Metallic map: 2
.It
Normal map: 3
.It
AO: 4
.It
Cube map positive x: 5
.It
Cube map negative x: 6
.It
Cube map positive y: 7
.It
Cube map negative y: 8
.It
Cube map positive z: 9
.It
Cube map negative z: 10
.It
Environment map: 11
.El
.It Fl v
Print verbose information
.El


.Sh FILES
.Pa cif_file
is the cif file the operation should be executed on. If no such file exists, one
will be created
 
.Pa png images
are the .png images that will be appended to the cif file, when using the
.Fl a
operation
 
.Pa /tmp/tmp.cif
is a temporary file used when deleting images. May be changed in the future


.Sh EXIT STATUS
.Ex -std