Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
CPTUPDATE(1)			  User commands 		    CPTUPDATE(1)

NAME
     cptupdate	-  create a GMT colour palette table (cpt) file with a different
     version to the input.

SYNOPSIS
     cptupdate [-b rgb] [-f rgb] [-h] [-H] [-m model]  [-n rgb]  [-o path]  [-S]
	       [-v] [-V] [-z] [-Z] [-4] [-5] [-6] [path]

DESCRIPTION
     The cptupdate program updates the colour palette in the input to a more re-
     cent (or older) version, optionally adding/removing features to the input.

     The  program  reads  any  version of the format, so can also be used to add
     hinges or normalise/denormalise version 6 input, or even  convert	to  ver-
     sions 5 or 4.

     The  program  will  read from stdin if a file is not specified as the final
     argument, and write to stdout if the --output option is not specified.

OPTIONS
     -b, --background rgb, --no-background
	 Set or remove the background colour of the output.

     --backtrace-file path
	 Specify a file to which to write a formatted backtrace. The  file  will
	 only  be created if there is a backtrace created, typically when an er-
	 ror occurs.

     --backtrace-format format
	 Specify the format of the backtrace written to the files  specified  by
	 --backtrace-file, one of plain, xml or json.

     --comments-read path
	 Read  the  comments  from the specified path and add them to the output
	 gradient.

	 The format is custom XML which should be fairly easy to  generate,  see
	 the output of --comments-write for examples.

     --comments-write path
	 Write the comments in the input to the specified path.

     --comments-retain
	 Use the comments in the input file as the comments for the output file.

     --comments-generate
	 Create a comment with summary data (the date of creation, name and ver-
	 sion of the cptutils package) in the output file.

     -f, --foreground rgb, --no-foreground
	 Set or remove the foreground colour of the output.

     -h, --help
	 Brief help.

     -H, --hinge-hard
	 Adds a HARD_HINGE to the output provided the output version is at least
	 6.

     -m, --model model
	 On  writing the output, convert all colours to the specified model, one
	 of "rgb" or "hsv". This has no effect on non-colour segments.

     -n, --nan rgb, --no-nan
	 Set or remove the NaN (no data) colour of the output.

     -o, --output path
	 Write the output to path, rather than stdout.

     -S, --hinge-soft
	 Adds a SOFT_HINGE to the output provided the output version is at least
	 6.

     -v, --verbose
	 Verbose operation.

     -V, --version
	 Version information.

     -z, --z-normalise
	 Normalise the z-values in the cpt output into the range 0/1 (or to -1/1
	 if a hinge is present) and add a RANGE directive if not present in  the
	 input. This is the form used in GMT master files.

	 This option requires that output cpt version is at least 5.

     -Z, --z-denormalise
	 Set  the  z-values  in the cpt output into the range given by the RANGE
	 directive, and remove that directive. If there is no  RANGE  then  this
	 option does nothing.

     -4, --gmt4
	 Use  GMT  4  conventions  when writing the cpt output: the colour-model
	 code is uppercase, and the colours are separated by spaces.

	 This option allows one to downgrade to version 4. If the input is  nor-
	 malised it will be denormalised, if the input has hinges, those will be
	 removed.

     -5, --gmt5
	 Use  GMT  5  conventions  when writing the cpt output: the colour-model
	 code is lowercase, and the colours are separated by a solidus for  RGB,
	 CMYK, by a dash for HSV.

	 This  option  allows  one  to	downgrade  from version 6 (in which case
	 hard/soft hinges will be converted to explicit hinges at zero)  or  up-
	 grade from version 4.

     -6, --gmt6
	 As  the  -5 option, but allows the HARD_HINGE and SOFT_HINGE directives
	 in place of the explicit HINGE = directive.

	 This option is the default, so redundant (but one  might  wish  to  fix
	 version 6 in anticipation later versions of the format).

EXAMPLE
     Update  a	version  4 cpt to version 6, adding a hard hinge and normalising
     the result, the typical format for a master file:

	 cptupdate -v -z -H -o new.cpt old.cpt

AUTHOR
     J.J. Green

cptutils 1.85			30 September 2025		    CPTUPDATE(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=cptupdate&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help