Initializing help system before first use

untar

Purpose
Extract files from a Unix tar archive.
Synopsis
procedure untar(opt:integer,tarfile:text,dir:text, filters:string)
procedure untar(tarfile:text,dir:text)
procedure untar(tarfile:text)
Arguments
opt 
Options:
SYS_OVERWRT 
Replace existing files
SYS_NODIR 
Do not extract directories (only files)
SYS_DIRONLY 
Extract only directories
SYS_FLAT 
Extract files without directory structure
SYS_VERB 
Report activity to the error stream
SYS_NOFAIL 
Do not abort procedure if a file cannot be written
tarfile 
File name of the archive
dir 
Destination path (default: current directory)
filters 
File name filters (default: all files extracted)
Example
The following extracts all files included in the archive myfiles.tar to directory mydir: 
untar("myfiles.tar","mydir")
Further information
1. The filters argument has a similar structure as the corresponding argument of procedure findfiles except that wildcard characters "*" and "?" may appear anywhere in a path. A file is extracted if it matches any of the patterns of this list.
2. When evaluating the filters, file name matching is achieved using function pathmatch and differences may be observed depending on the operating system ( e.g. file names are case sensitive under Posix systems but not under Windows).
3. This implementation processes only regular files, symbolic links (when supported by the system) and directories: other file types included in the archive are silently ignored.
4. By default file names are expected to be represented according the current system encoding in the archive. To select a different encoding use the enc: file name prefix (see Section Character encoding of text files) on the archive name ( e.g. "enc:utf-8,myarc.tar").
Related topics
tarlist, newtar, unzip, getsysstat
Module
mmsystem

Parent Topic Procedures and functions

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.