65 lines
2.0 KiB
Markdown
65 lines
2.0 KiB
Markdown
# Advanced Usage
|
|
|
|
There are various options for using PeterDocs. The following sections will cover some of these.
|
|
|
|
## File Filter
|
|
|
|
The ``-FileFilter`` parameter allows selection of files tha are to be included into the archive file.
|
|
The parameter only applies to the compress function or buidling the reconciliation file.
|
|
|
|
For example:
|
|
|
|
```powershell
|
|
Compress-Peter -SourceFolder "~/Pictures/" -Secret "c0mpleX%S3cret" -FileFiletr "*.jpg"
|
|
```
|
|
|
|
will only include files with the extension ".jpg"
|
|
|
|
```powershell
|
|
Compress-Peter -SourceFolder "~/Pictures/" -Secret "c0mpleX%S3cret" -FileFiletr "IMG9*.jpg"
|
|
```
|
|
|
|
will only include files with the extension ".jpg" and starting with the characters "IMG90"
|
|
|
|
## ReconcileFile
|
|
|
|
The ``-ReconcileFile`` parameter allows specification of the reocnciliation file if you
|
|
wish to select your own name.
|
|
|
|
For example:
|
|
|
|
```powershell
|
|
Compress-Peter -SourceFolder "~/Pictures/" -Secret "c0mpleX%S3cret" -ReconcileFile "reconcile_batch2.csv"
|
|
```
|
|
|
|
will generate a reconcile file named "reconcile_batch2.csv" and place it into the 7Zip archive. Remember
|
|
to specify the reconcile file on the compare, something like this:
|
|
|
|
```powershell
|
|
Compare-Peter -RestoreFolder "c:\backup\pictures" -ReconcileFile "reconcile_batch2.csv"
|
|
```
|
|
|
|
## SecretFile
|
|
|
|
The ``-SecretFile`` parameter allows specification of the secret file if you
|
|
wish to select your own name. This parameter is only applicable with the
|
|
``-RecipientKey`` parameter
|
|
|
|
For example:
|
|
|
|
```powershell
|
|
Compress-Peter -SourceFolder "~/Pictures/" -RecipientKey "meerkat@merebox.com" -SecretFile "mypictures.key"
|
|
```
|
|
|
|
will generate a secret file named "mypictures.key". Remember to send this file to your recipient
|
|
and to specify the secret file on the expand, something like this:
|
|
|
|
```powershell
|
|
Expand-Peter -RestoreFolder "c:\backup\pictures" -RecipientKey "meerkat@merebox.com" -SecretFile "mypictures.key" -ArchiveFile "myarchive.7z"
|
|
```
|
|
|
|
## LogPath
|
|
|
|
The ``-LogPath`` parameter allows definition of the folder that will contain the
|
|
execution log.
|