Libraries
Tar commands Source Code
 previous   up   next 

Function Summary
void
tarTell (inout file: inFile, in array string: memberList, in boolean: doView)
List the files in the TAR achive inFile.
void
tarTell (in string: inFileName, in array string: memberList, in boolean: doView, in boolean: complainIfUncompressed)
List files in the possibly compressed TAR achive named inFileName.
void
tarXtract (inout file: inFile, in array string: memberList, in boolean: doView)
Extract files from the TAR achive inFile.
void
tarXtract (in string: inFileName, in array string: memberList, in boolean: doView, in boolean: complainIfUncompressed)
Extract files from the possibly compressed TAR achive named inFileName.
void
tarXtract (in string: inFileName, in boolean: doView)
Extract files from the possibly compressed TAR achive named inFileName.
void
tarXtract (in string: inFileName)
Extract files from the possibly compressed TAR achive named inFileName.
void
tarCreate (inout file: outFile, in string: basePath, in string: pathFromBase, in array string: fileList, in boolean: doView)
Write a TAR archive to outFile with the files listed in fileList.
void
tarCreate (in string: outFileName, in array string: fileList, in boolean: doView, in boolean: doZip)
Create the TAR file outFileName with the files listed in fileList.
void
tarCreate (in string: outFileName, in array string: fileList, in boolean: doView)
Create the TAR file outFileName with the files listed in fileList.
void
tarCreate (in string: outFileName, in array string: fileList)
Create the TAR file outFileName with the files listed in fileList.

Function Detail

tarTell

const proc: tarTell (inout file: inFile, in array string: memberList, in boolean: doView)

List the files in the TAR achive inFile. This function is used by the tar7 program. In other application areas the tar file system might be more convenient.

aFile := open("test.tar", "r");
if aFile <> STD_NULL then
  tarTell(aFile, 0 times "", TRUE);
  ...
Parameters:
inFile - File in TAR format.
memberList - List of archive members that should be listed. If memberList is empty all files in the archive are listed.
doView - TRUE show details of the files in the archive, FALSE only write the names of the files in the archive.

tarTell

const proc: tarTell (in string: inFileName, in array string: memberList, in boolean: doView, in boolean: complainIfUncompressed)

List files in the possibly compressed TAR achive named inFileName. If the archive is compressed with GZIP, XZ, ZSTD or LZMA it is uncompressed. This function is used by the tar7 program. In other application areas the tar file system might be more convenient.

tarTell("test.tar", 0 times "", FALSE, FALSE);
tarTell("test.tgz", 0 times "", FALSE, TRUE);
Parameters:
inFileName - Name of the TAR archive.
memberList - List of archive members that should be listed. If memberList is empty all files in the archive are listed.
doView - TRUE show details of the files in the archive, FALSE only write the names of the files in the archive.
complainIfUncompressed - TRUE complain if the archive is not compressed, FALSE silently accept an uncompressed archive.

tarXtract

const proc: tarXtract (inout file: inFile, in array string: memberList, in boolean: doView)

Extract files from the TAR achive inFile. This function is used by the tar7 program. The function extracts files directly to the hard-disk respectively solid-state drive of the operating system. In other application areas the tar file system might be more convenient.

aFile := open("test.tar", "r");
if aFile <> STD_NULL then
  tarXtract(aFile, 0 times "", FALSE);
  ...
Parameters:
inFile - File in TAR format.
memberList - List of archive members that should be extracted. If memberList is empty all files in the archive are extracted.
doView - TRUE write the names of the extracted files, FALSE extract quietly.

tarXtract

const proc: tarXtract (in string: inFileName, in array string: memberList, in boolean: doView, in boolean: complainIfUncompressed)

Extract files from the possibly compressed TAR achive named inFileName. If the archive is compressed with GZIP, XZ, ZSTD or LZMA it is uncompressed. This function is used by the tar7 program. The function extracts files directly to the hard-disk respectively solid-state drive of the operating system. In other application areas the tar file system might be more convenient.

tarXtract("test.tar", 0 times "", FALSE, FALSE);
tarXtract("test.tgz", 0 times "", FALSE, TRUE);
Parameters:
inFileName - Name of the TAR archive.
memberList - List of archive members that should be extracted. If memberList is empty all files in the archive are extracted.
doView - TRUE write the names of the extracted files, FALSE extract quietly.
complainIfUncompressed - TRUE complain if the archive is not compressed, FALSE silently accept an uncompressed archive.

tarXtract

const proc: tarXtract (in string: inFileName, in boolean: doView)

Extract files from the possibly compressed TAR achive named inFileName. If the archive is compressed with GZIP, XZ, ZSTD or LZMA it is uncompressed. This function extracts files directly to the hard-disk respectively solid-state drive of the operating system. In other application areas the tar file system might be more convenient.

tarXtract("test.tar", TRUE);
tarXtract("test.tgz", FALSE);
Parameters:
inFileName - Name of the TAR archive.
doView - TRUE write the names of the extracted files, FALSE extract quietly.

tarXtract

const proc: tarXtract (in string: inFileName)

Extract files from the possibly compressed TAR achive named inFileName. If the archive is compressed with GZIP, XZ, ZSTD or LZMA it is uncompressed. This function extracts files directly to the hard-disk respectively solid-state drive of the operating system. In other application areas the tar file system might be more convenient.

tarXtract("test.tar");
tarXtract("test.tgz");
Parameters:
inFileName - Name of the TAR archive.

tarCreate

const proc: tarCreate (inout file: outFile, in string: basePath, in string: pathFromBase, in array string: fileList, in boolean: doView)

Write a TAR archive to outFile with the files listed in fileList. This function is used by the tar7 program. The function copies files from the hard-disk respectively solid-state drive of the operating system. In other application areas the tar file system might be more convenient.

aFile := open("test.tar", "w");
if aFile <> STD_NULL then
  tarCreate(aFile, "", "", [] ("test_dir"), FALSE);
  ...
  write(aFile, END_OF_FILE_MARKER mult 2);
  close(aFile);
Parameters:
outFile - Destination for the crated TAR file.
basePath - Base path for all files to be processed.
pathFromBase - Path from basePath for the files in fileList.
fileList - List of file paths to be put into the created tar archive.
doView - TRUE write the names of the processed files, FALSE work quietly.

tarCreate

const proc: tarCreate (in string: outFileName, in array string: fileList, in boolean: doView, in boolean: doZip)

Create the TAR file outFileName with the files listed in fileList. This function is used by the tar7 program. The function copies files from the hard-disk respectively solid-state drive of the operating system. In other application areas the tar file system might be more convenient.

tarCreate("test.tar", [] ("test_file1", "test_file2"), FALSE, FALSE);
tarCreate("test.tgz", [] ("test_file1", "test_file2"), FALSE, TRUE);
Parameters:
outFileName - Name of the TAR archive to be created.
fileList - List of file paths to be put into the created tar archive.
doView - TRUE to log a line for every processed file, FALSE if nothing should be logged.
doZip - TRUE if the TAR archive should be compressed with ZIP, FALSE if the TAR achive should be uncompressed.

tarCreate

const proc: tarCreate (in string: outFileName, in array string: fileList, in boolean: doView)

Create the TAR file outFileName with the files listed in fileList. This function copies files from the hard-disk respectively solid-state drive of the operating system. In other application areas the tar file system might be more convenient.

tarCreate("test.tar", [] ("test_file1", "test_file2"), TRUE);
Parameters:
outFileName - Name of the TAR archive to be created.
fileList - List of file paths to be put into the created tar archive.
doView - TRUE to log a line for every processed file, FALSE if nothing should be logged.

tarCreate

const proc: tarCreate (in string: outFileName, in array string: fileList)

Create the TAR file outFileName with the files listed in fileList. This function copies files from the hard-disk respectively solid-state drive of the operating system. In other application areas the tar file system might be more convenient.

tarCreate("test.tar", [] ("test_file1", "test_file2"));
Parameters:
outFileName - Name of the TAR archive to be created.
fileList - List of file paths to be put into the created tar archive.


 previous   up   next