Nulo/tar-stream
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

moved some sections

Browse source
This commit is contained in:
Mathias Buus 2013-12-20 20:54:01 +01:00
parent 315814b52e
commit 611c4c8682
1 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -56,6 +56,26 @@ extract.on('finish', function() {
pack.pipe(extract); pack.pipe(extract);
``` ```
## Headers
The header object using in `entry` should contain the following properties.
Most of these values can be found by stating a file.
``` js
{
name: 'path/to/this/entry.txt',
size: 1314, // entry size. defaults to 0
mode: 0644, // entry mode. defaults to to 0755 for dirs and 0644 otherwise
mtime: new Date(), // last modified date for entry
type: 'file', // type of entry. can be file|directory|link|block|character|fifo
linkname: 'path', //
uid: 0, // uid of entry owner. defaults to 0
gid: 0, // gid of entry owner. defaults to 0
uname: 'maf', // uname of entry owner. defaults to null
gname: 'wheel', // gname of entry owner. defaults to null
}
```
## Modifying existing tarballs ## Modifying existing tarballs
Using tar-stream it is easy to rewrite paths / change modes etc in an existing tarball. Using tar-stream it is easy to rewrite paths / change modes etc in an existing tarball.
@ -84,26 +104,6 @@ oldTarball.pipe(extract);
pack.pipe(newTarball); pack.pipe(newTarball);
``` ```
## Headers
The header object using in `entry` should contain the following properties.
Most of these values can be found by stating a file.
``` js
{
name: 'path/to/this/entry.txt',
size: 1314, // entry size. defaults to 0
mode: 0644, // entry mode. defaults to to 0755 for dirs and 0644 otherwise
mtime: new Date(), // last modified date for entry
type: 'file', // type of entry. can be file|directory|link|block|character|fifo
linkname: 'path', //
uid: 0, // uid of entry owner. defaults to 0
gid: 0, // gid of entry owner. defaults to 0
uname: 'maf', // uname of entry owner. defaults to null
gname: 'wheel', // gname of entry owner. defaults to null
}
```
# License # License
MIT MIT