README
¶
targz
Archive directory to tar.gz and extract tar.gz to directory
Example
package main
import (
"os"
"github.com/gammazero/targz"
)
func main() {
// Create archive of backup directory.
err := targz.Create("/tmp/myfiles/backup", "/tmp/backup.tar.gz")
if err != nil {
panic(err)
}
// Extract archive into /tmp/restore/ to create /tmp/restore/backup.
os.MkdirAll("/tmp/restore", 0750)
err = targz.Extract("/tmp/backup.tar.gz", "/tmp/restore")
if err != nil {
panic(err)
}
}
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Create ¶
Create creates a gzip compressed tar file containing the contents of the specified directory.
If the directory to archive is specified by a path such as "/tmp/myfiles/backups/weekly", then only the "weekly" directory, and none of its parent path, is added to the tar archive. When extracted, a "weekly" directory is created with all of its archived contents.
func CreateWriter ¶ added in v0.0.3
Create writes a gzip compressed tar file to an io.Writer. The tar file contains the contents of the specified directory.
Types ¶
type Option ¶
type Option func(*config)
Option is a function that sets a value in a config.
func WithIgnore ¶
WithIgnore specifies file names to ignore when creating an archive. Multiple names to ignore can be specified in a single call and in multiple calls to WithIgnore.
Source Files