diff --git a/repos/libports/src/app/extract/README b/repos/libports/src/app/extract/README new file mode 100644 index 0000000000..f0e9e566f2 --- /dev/null +++ b/repos/libports/src/app/extract/README @@ -0,0 +1,28 @@ +The 'extract' component extracts archives using libarchive. + +Configuration +~~~~~~~~~~~~~ + +The following snippet shows how to configure the component to extract +multiple archives one at a time: + +! +! +! +! +! +! +! +! +! +! +! + +Each 'extract' node contains the source path to the archive in its 'archive' +attribute. The destination path, where the content of the archive should be +placed, is specified by the 'to' attribute. The 'strip' attribute denotes +how many path elements should be removed from the files stored in the archive +during extraction. In this example the top directory would be omitted. The +'name' attribute is used for naming compressed files that are not part of an +archive.