## gzf - gzip File

### Module Description

The gzf module implements the base definitions for using a gzip file. It is used by the [zif] and, in a future version, [zof] module.

### Module Words

#### Operating Systems constants

gzf.fat ( -- n )
  FAT OS
gzf.amiga ( -- n )
  Amiga OS
gzf.vms ( -- n )
  VMS OS
gzf.unix ( -- n )
  UNIX OS
gzf.vm/cms ( -- n )
  VM-CMS OS
gzf.atari ( -- n )
  ATARI OS
gzf.hpfs ( -- n )
  HPFS OS
gzf.macintos ( -- n )
  MACINTOS OS
gzf.z-system ( -- n )
  Z-SYSTEM OS
gzf.cp/m ( -- n )
  CP-M OS
gzf.tops-20 ( -- n )
  TOPS-20 OS
gzf.ntfs ( -- n )
  NTFS OS
gzf.qdos ( -- n )
  QDOS OS
gzf.acorn ( -- n )
  ACORN OS
gzf.unknown ( -- n )
  other

#### Compression modes constants

gzf.deflate ( -- n )
  Deflate Compression mode

#### gzf structure

gzf% ( -- n )
  Get the required space for a gzf variable

#### gzip file variable creation, initialisation and destruction

gzf-init ( gzf -- )
  Initialise the gzip file variable
gzf-(free) ( gzf -- )
  Free the internal, private variables from the heap
gzf-create ( "<spaces>name" -- ; -- gzf )
  Create a named gzip file variable in the dictionary
gzf-new ( -- gzf )
  Create a new gzip file variable on the heap
gzf-free ( gzf -- )
  Free the variable from the heap

#### Member words

gzf-text@ ( gzf -- flag )
  Get if the source of the current file in the gzip file is text
gzf-text! ( flag gzf -- )
  Set if the source for the next file in the gzip file is text
gzf-flags@ ( gzf -- u )
  Get the flags from the gzip file header
gzf-flags! ( u gzf -- )
  Set the flags for the gzip file header
gzf-os@ ( gzf -- n )
  Get the operating system of the current file in the gzip file
gzf-os! ( n gzf -- )
  Set the operating system for the next file in the gzip file
gzf-mtime@ ( gzf -- u )
  Get the modification time of the current file in the gzip file in seconds since unix epoch
gzf-mtime! ( u gzf -- )
  Set the modification time for the next file in the gzip file in seconds since unix epoch
gzf-name@ ( gzf -- c-addr u )
  Get the name of the current file in the gzip file
gzf-name! ( c-addr u gzf -- )
  Set the name of the next file in the gzip file
gzf-comment@ ( gzf -- c-addr u )
  Get the comment of the current file in the gzip file
gzf-comment! ( c-addr u gzf -- )
  Set the comment for the next file in the gzip file

#### Header words

gzf-reset ( gzf -- )
  Reset the gzip file header

#### Inspection

gzf-dump ( gzf -- )
  Dump the variable

generated 03-Jun-2010 by ofcfrth-0.10.0