---
name: "rl2tool"
section: "1"
platform: "linux"
package: "rasterlite2-bin"
version: "1.1.0~beta1-4"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/rl2tool"
---

# rl2tool(1)

CLI tool for RasterLite2

## NAME

rl2tool - CLI tool for RasterLite2

## SYNOPSIS

FC**rl2tool**F\[0\]  *mode* \[*ARGLIST*\]

## DESCRIPTION

**rl2tool** is a CLI tool for RasterLite2.

## OPTIONS

Mode: CREATE

will create a new RasterLite2 Raster Coverage

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-smp**F\[0\] *keyword*, FC**--sample-type**F\[0\] *keyword*

  Sample Type keyword (see list)

- FC**-pxl**F\[0\] *keyword*, FC**--pixel-type**F\[0\] *keyword*

  Pixel Type keyword (see list)

- FC**-bds**F\[0\] *integer*, FC**--num-bands**F\[0\] *integer*

  Number of Bands

- FC**-cpr**F\[0\] *keyword*, FC**--compression**F\[0\] *keyword*

  Compression keyword (see list)

- FC**-qty**F\[0\] *integer*, FC**--quality**F\[0\] *integer*

  Compression Quality \[0-100\]

- FC**-tlw**F\[0\] *integer*, FC**--tile-width**F\[0\] *integer*

  Tile Width \[pixels\]

- FC**-tlh**F\[0\] *integer*, FC**--tile-height**F\[0\] *integer*

  Tile Height \[pixels\]

- FC**-srid**F\[0\] *integer*, FC**--srid**F\[0\] *integer*

  SRID value

- FC**-nosrid**F\[0\], FC**--no-srid**F\[0\]

  No SRID

- FC**-res**F\[0\] *number*, FC**--resolution**F\[0\] *number*

  pixel resolution(X and Y)

- FC**-xres**F\[0\] *number*, FC**--x-resol**F\[0\] *number*

  pixel resolution(X specific)

- FC**-yres**F\[0\] *number*, FC**--y-resol**F\[0\] *number*

  pixel resolution(Y specific)

- FC**-nd**F\[0\] *pixel*, FC**--no-data**F\[0\] *pixel*

  NO-DATA pixel value

SampleType Keywords:

1-BIT 2-BIT 4-BIT INT8 UINT8 INT16 UINT16 INT32 UINT32 FLOAT DOUBLE

PixelType Keywords:

MONOCHROME PALETTE GRAYSCALE RGB MULTIBAND DATAGRID

Compression Keywords:

NONE DEFLATE LZMA GIF PNG JPEG WEBP LL\_WEBP FAX3 FAX4

Mode: DROP

will drop an existing RasterLite2 Raster Coverage

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

Mode: IMPORT

will create a new Raster Section by importing an external image or raster file

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-src**F\[0\] *pathname*, FC**--src-path**F\[0\] *pathname*

  input Image/Raster path

- FC**-dir**F\[0\] *pathname*, FC**--dir-path**F\[0\] *pathname*

  input directory path

- FC**-ext**F\[0\] *string*, FC**--file-ext**F\[0\] *string*

  extension file extension (e.g. .tif)

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-srid**F\[0\] *integer*, FC**--srid**F\[0\] *integer*

  optional: force SRID value

- FC**-wf**F\[0\]\>, FC**--worldfile**F\[0\]

  requires a Worldfile

- FC**-pyr**F\[0\], FC**--pyramidize**F\[0\]

  immediately build Pyramid levels

Mode: EXPORT

will export an external image from a Coverage

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-dst**F\[0\] *pathname*, FC**--dst-path**F\[0\] *pathname*

  output Image/Raster path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-res**F\[0\] *number*, FC**--resolution**F\[0\] *number*

  pixel resolution (X and Y)

- FC**-xres**F\[0\] *number*, FC**--x-resol**F\[0\] *number*

  pixel resolution (X specific)

- FC**-yres**F\[0\] *number*, FC**--y-resol**F\[0\] *number*

  pixel resolution (Y specific)

- FC**-minx**F\[0\] *number*, FC**--min-x**F\[0\] *number*

  X coordinate (lower-left corner)

- FC**-miny**F\[0\] *number*, FC**--min-y**F\[0\] *number*

  Y coordinate (lower-left corner)

- FC**-maxx**F\[0\] *number*, FC**--max-x**F\[0\] *number*

  X coordinate (upper-right corner)

- FC**-maxy**F\[0\] *number*, FC**--max-y**F\[0\] *number*

  Y coordinate (upper-left corner)

- FC**-cx**F\[0\] *number*, FC**--center-x**F\[0\] *number*

  X coordinate (center)

- FC**-cy**F\[0\] *number*, FC**--center-y**F\[0\] *number*

  Y coordinate (center)

- FC**-outw**F\[0\] *number*, FC**--out-width**F\[0\] *number*

  image width (in pixels)

- FC**-outh**F\[0\] *number*, FC**--out-height**F\[0\] *number*

  image height (in pixels)

In order to export a raster you are expected to specify:

- \- the intended resolution (FC**-res**F\[0\] OR FC**-xres**F\[0\] AND FC**-yres**F\[0\])

  - \- the output image size (FC**-outw**F\[0\] AND FC**-outh**F\[0\])

  - \- a single tie-point, defined as one of:

  - \- Output Image Center point: FC**-cx**F\[0\] AND FC**-cy**F\[0\]

    - \- Output Image LowerLeft corner: FC**-minx**F\[0\] AND FC**-miny**F\[0\]

    - \- Output Image LowerRight corner: FC**-maxx**F\[0\] AND FC**-miny**F\[0\]

    - \- Output Image UpperLeft corner: FC**-minx**F\[0\] AND FC**-maxy**F\[0\]

    - \- Output Image UpperRight corner: FC**-maxx**F\[0\] AND FC**-maxy**F\[0\]

    Mode: DELETE

will delete a Raster Section

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-sec**F\[0\] *string*, FC**--section**F\[0\] *string*

  Section's name

Mode: PYRAMIDIZE

will (re)build all Pyramid levels supporting a Coverage

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-sec**F\[0\] *string*, FC**--section**F\[0\] *string*

  optional: Section's name

  default is "All Sections"

- FC**-f**F\[0\], FC**--force**F\[0\]

  optional: rebuilds from scratch

Mode: PYRAMIDIZE-MONOLITHIC

will (re)build all Pyramid levels (Monolithic) supporting a Coverage

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-lev**F\[0\] *number*, FC**--virt-levels**F\[0\] *number*

  number of virt-levels

  could be one of: 1, 2 or 3

Mode: DE-PYRAMIDIZE

will delete Pyramid levels

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-sec**F\[0\] *string*, FC**--section**F\[0\] *string*

  optional: Section's name

  default is "All Sections"

Mode: LIST

will list Raster Sections within a Coverage

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-sec**F\[0\] *string*, FC**--section**F\[0\] *string*

  optional: Section's name

  default is "All Sections"

Mode: MAP

will output a PNG Map representing all Raster Sections within a Coverage

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-dst**F\[0\] *pathname*, FC**--dst-path**F\[0\] *pathname*

  output Image/Raster path

- FC**-outw**F\[0\] *number*, FC**--out-width**F\[0\] *number*

  image width (in pixels)

- FC**-outh**F\[0\] *number*, FC**--out-height**F\[0\] *number*

  image height (in pixels)

Mode: CATALOG

will list all Coverages from within a RasterLite2 DB

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

Mode: HISTOGRAM

will create a PNG showing a band Histogram

- FC**-db**F\[0\] *pathname*, FC**--db-path**F\[0\] *pathname*

  RasterLite2 DB path

- FC**-cov**F\[0\] *string*, FC**--coverage**F\[0\] *string*

  Coverage's name

- FC**-sec**F\[0\] *string*, FC**--section**F\[0\] *string*

  optional: Section's name

  default is "All Sections"

- FC**-bnd**F\[0\] *integer*, FC**--band-index**F\[0\] *integer*

  a valid band index

  default is band index 0

- FC**-dst**F\[0\] *pathname*, FC**--dst-path**F\[0\] *pathname*

  output PNG path

  default is FC*./hist\_cov\_sec\_idx.png*F\[0\]

optional DB specific settings:

- FC**-cs**F\[0\] *num*, FC**--cache-size**F\[0\] *num*

  DB cache size (how many pages)

- FC**-m**F\[0\], FC**--in-memory**F\[0\]

  using IN-MEMORY database

- FC**-jo**F\[0\], FC**--journal-off**F\[0\]

  unsafe \[but faster\] mode