Class Types
Class | Summary |
---|---|
AddCommand |
Adds files to archive.
(Command: a).
The builder is |
AddCommandBuilder |
Builder for AddCommand .
|
Argument |
Extensions for all Builders that support IHaveArgumentArchive .
|
Argument |
Extensions for all Builders that support IHaveArgumentDirectories .
|
ArgumentFilesBuilder |
Extensions for all Builders that support IHaveArgumentFiles .
|
Base |
BaseClass for add,update,delete. |
BaseBoolSwitch | BaseClass for simple boolean switches. |
BaseCommand | BaseClass for Commands. |
BaseOutputBuilder |
Base for builders that support BaseOutputCommand<T> .
|
BaseOutputCommand |
base for all commands that have output. (E.g. InformationCommand ).
|
BaseSwitchCollection |
Base for switches that can be given multiple times.
An example is ISupportSwitchExcludeFilenames (-x!*.pdf -x!*.xml) which uses
SwitchExcludeFilenameCollection (which implements this BaseCollection) to set
multiple SwitchExcludeFilename .
|
BenchmarkCommand |
Measures speed of the CPU.
Benchmark execution also can be used to check RAM for errors.
(Command: b).
The builder is |
Benchmark |
Builder for BenchmarkCommand .
|
CommandBuilder |
Builder for all ICommand s.
Do NOT call In...Mode() multiple times.
|
DeleteCommand |
Deletes files from the archive.
(Command: d).
The builder is |
DeleteCommandBuilder |
Builder for DeleteCommand .
|
ExtractCommand |
Extract files from archive - with or without full path
(Commands: e and x).
With UseFullPath set to false, this represents the e-command: Extracts files from an archive to the current directory or to the output directory. The output directory can be specified by -o (Set Output Directory) switch. This command copies all extracted files to one directory. With UseFullPath set to true, this represents the x-command: Extracts files from an archive with their full paths in the current directory, or in an output directory if specified.
The builder is |
Extract |
Builder for ExtractCommand .
|
HashCommand |
Calculates the hash for one or more files
(Command: h).
The builder is |
HashCommandBuilder |
Builder for HashCommand .
|
InformationCommand |
Show information about supported formats
(Command: i).
The builder is |
Information |
Builder for InformationCommand .
|
ListCommand |
Show List about supported formats
(Command: i).
The builder is |
ListCommandBuilder |
Builder for ListCommand .
|
OverwriteMode |
Specifies the overwrite mode during extraction, to overwrite files already present on disk.
|
RecurseType |
Specifies the method of treating wildcards and filenames on the command line.
|
RenameCommand |
Show Rename about supported formats
(Command: rn).
The builder is |
RenameCommandBuilder |
Builder for RenameCommand .
|
RenamePair |
A pair or old- and new name for the RenameCommand .
|
SevenZipAliases |
Functions to call 7-Zip. In order to use this add-in, 7z.exe or 7za.exe has to be available. One option is using 7-Zip.CommandLine from nuget. The other option is to have 7z installed on your system (I.e. There is a registry-key HKLM/Software/7-Zip/Path that points to a directory containing 7z.exe or 7za.exe). Supported formats and capabilities depend on your 7z-version. To install add the following lines to your cake-file:
|
SevenZipRunner | The Tool-Runner for 7zip. |
SevenZipSettings | Settings for running 7zip. |
SwitchArchiveType |
-t (set Type of archive) switch. Specifies the type of archive.
|
Switch |
Extensions for all Builders that support ISupportSwitchArchiveType .
|
Switch |
-ssw (Compress files open for writing) switch. Compresses files open for writing by another applications. If this switch is not set, 7-zip doesn't include such files to archive.
|
Switch |
Extensions for all Builders that support ISupportSwitchCompressFilesOpenForWriting .
|
Switch |
-m (Set compression Method) switch. Specifies the compression method.
|
Switch |
Extensions for all Builders that support ISupportSwitchCompressionMethod .
|
Switch |
-sdel (Delete files after compression) switch. If -sdel switch is specified, 7-Zip deletes files after including to archive. So it works like moving files to archive. 7-Zip deletes files at the end of operation and only if archive was successfully created.
|
Switch |
Extensions for all Builders that support ISupportSwitchDeleteAfterCompression .
|
Switch |
-an (Disable parsing of archive_name) switch. Disables parsing of the archive_name field on the command line. This switch must be used with the -ai (Include archives) switch. If you use a file list for your archives, you specify it with the -ai switch, so you need to disable parsing of archive_name field from command line.
|
Switch |
Extensions for all Builders that support ISupportSwitchDisableParsingOfArchiveName .
|
Switch |
-ax (Exclude archive filenames) switch. Specifies archives to be excluded from the operation. Multiple exclude archive switches are supported.
|
Switch |
A Collection of SwitchExcludeArchiveFilename .
|
Switch |
Extensions for all Builders that support ISupportSwitchExcludeArchiveFilenames .
|
Switch |
-x (Exclude filenames) switch. Specifies which filenames or wildcard-names must be excluded from the operation. Multiple exclude switches are supported.
|
Switch |
A Collection of SwitchExcludeFilename .
|
Switch |
Extensions for all Builders that support ISupportSwitchExcludeFilenames .
|
Switch |
-spf (Use fully qualified file paths) switch.
(Also, -spf2 for full paths without drive letters.)
Enables the mode that allows to use fully qualified file paths in archives. If -spf switch is not specified, 7-Zip reduces file paths to relative paths when it adds files to archive, and 7-Zip converts paths to relative paths when you extract archive. If -spf switch is specified, 7-Zip doesn't try to process or convert paths.
|
Switch |
Extensions for all Builders that support ISupportSwitchFullyQualifiedFilePaths .
|
Switch |
-ai (Include archive filenames) switch. Specifies additional include archive filenames and wildcards. Multiple include switches are supported.
|
Switch |
A Collection of SwitchIncludeArchiveFilename .
|
Switch |
Extensions for all Builders that support ISupportSwitchIncludeArchiveFilenames .
|
Switch |
-i (Include filenames) switch. Specifies additional include filenames and wildcards. Multiple include switches are supported.
|
Switch |
A Collection of SwitchIncludeFilename .
|
Switch |
Extensions for all Builders that support ISupportSwitchIncludeFilenames .
|
Switch |
-sns (Store NTFS alternate Streams) switch. If -sns mode is enabled, 7-Zip processes NTFS Alternate Data Streams for files and folders. Current version of 7-Zip can store NTFS alternate streams only to WIM archives. Note: 7-Zip can't include alternate streams to archives on 32-bit Windows XP and older systems.
|
Switch |
Extensions for all Builders that support ISupportSwitchNtfsAlternateStreams .
|
Switch |
-sni (Store NT security information) switch. Use this switch to store and restore NT (NTFS) security information for files and directories. Note that only NTFS file system supports that feature. Current version of 7-Zip can store NT security information only to WIM archives.
|
Switch |
Extensions for all Builders that support ISupportSwitchNtSecurityInformation .
|
Switch |
-o (set Output directory) switch. Specifies a destination directory where files are to be extracted. This switch can be used only with extraction commands.
|
Switch |
Extensions for all Builders that support ISupportSwitchOutputDirectory .
|
SwitchOverwriteMode |
-ao (Overwrite mode) switch. Specifies the overwrite mode during extraction, to overwrite files already present on disk.
|
Switch |
Extensions for all Builders that support ISupportSwitchOverwriteMode .
|
SwitchPassword |
-p (set Password) switch. Specifies password.
|
Switch |
Extensions for all Builders that support ISupportSwitchPassword .
|
Switch |
-r (Recurse subdirectories) switch. Specifies the method of treating wildcards and filenames on the command line.
|
Switch |
Extensions for all Builders that support ISupportSwitchRecurseSubdirectories .
|
Switch |
-sfx (Create SFX archive) switch. Specifies the SFX module that will be combined with the archive. This module must be placed in the same directory as the 7z.exe. If {SFX_Module} is not assigned, 7-Zip will use standard console SFX module 7zCon.sfx.
|
Switch |
Extensions for all Builders that support ISupportSwitchSelfExtractingArchive .
|
Switch |
-scrc (Set hash function) switch. Sets hash function for "extract" and "hash" commands.
|
Switch |
Extensions for all Builders that support ISupportSwitchSetHashFunction .
|
Switch |
A Collection of SwitchSetHashFunction .
|
Switch |
-stl (Set archive time-stamp from the most recently modified file) switch. If -stl switch is specified, 7-Zip sets time-stamp for archive file as time-stamp from the most recently modified file in that archive.
|
Switch |
Extensions for all Builders that support ISupportSwitchTimestampFromMostRecentFile .
|
Switch |
-slt (Show technical information) switch. Sets technical mode for l (List) command.
|
Switch |
Extensions for all Builders that support ISupportSwitchShowTechnicalInformation .
|
SwitchUpdateOptions |
-u (Update options) switch. Specifies how to update files in an archive and (or) how to create new archives.
|
Switch |
Extensions for all Builders that support ISupportSwitchUpdateOptions .
|
SwitchVolume |
-v (Create Volumes) switch. Specifies volume sizes.
|
SwitchVolumeBuilder |
Extensions for all Builders that support ISupportSwitchVolume .
|
Switch |
A Collection of SwitchVolume .
|
Switch |
-w (set Working directory) switch. Sets the working directory for the temporary base archive. By default, 7-Zip builds a new base archive file in the same directory as the old base archive file. By specifying this switch, you can set the working directory where the temporary base archive file will be built. After the temporary base archive file is built, it is copied over the original archive; then, the temporary file is deleted.
|
Switch |
Extensions for all Builders that support ISupportSwitchWorkingDirectory .
|
TestCommand |
Test one or more archives
(Command: t).
The builder is |
TestCommandBuilder |
Builder for TestCommand .
|
UpdateAction |
Specifies the action for a given SwitchUpdateOptions -State.
|
UpdateCommand |
Update older files in the archive and add files that are not already in the archive.
(Command: u)
Note: the updating of solid .7z archives can be slow, since it can require some re-compression.
The builder is |
UpdateCommandBuilder |
Builder for UpdateCommand .
|
VolumeUnit |
Units for SwitchCompressionMethod .
|
Interface Types
Interface | Summary |
---|---|
I |
The parsed output one file inside an IArchiveListOutput of the ListCommand .
|
IArchiveListOutput |
The parsed output one archive of the ListCommand .
|
IArchiveTestOutput |
The parsed output of individual archives the TestCommand .
|
IBenchmarkOutput |
The parsed Output of the BenchmarkCommand .
|
ICommand |
Interface for all commands. (E.g. AddCommand ).
|
IFileHash |
The information of one file, as generated by the HashCommand .
Used in the |
IHash |
Represents a hash (for a given hash-function) in the output of the HashCommand .
Used in |
IHashOutput |
The parsed output of the HashCommand .
|
IHaveArgument | Base for all arguments. |
IHaveArgumentArchive | Interface for all commands supporting the Archive-Argument. |
I |
Interface for all commands supporting multiple directories as arguments. |
IHaveArgumentFiles | Interface for all commands supporting multiple files as arguments. |
IInformationOutput |
The parsed Output of the InformationCommand .
|
IListOutput |
The parsed Output of the ListCommand .
|
IOutput |
General output. Common to all Cake.SevenZip.Parsers.IOutputParser`1 s.
|
I |
Base for builders that support arguments. |
ISupportSwitch |
Interfaces for all switches.
Commands "support" switches by implementing an ISupportSwitch
(e.g. ISupportSwitchPassword is implemented in all commands
that support setting a password (-p).
|
I |
Command supports switch -t (set Type of archive).
The Switch is
The Builder is |
I |
Base for builders that support switches. |
I |
Command supports switch -ssw (Compress files open for writing).
The Switch is
The Builder is |
I |
Command supports switch -m (Set compression Method).
The Switch is
The Builder is |
I |
Command supports switch -sdel (Delete files after compression).
The Switch is
The Builder is |
I |
Command supports switch -an (Disable parsing of archive_name).
The Switch is
The Builder is |
I |
Command supports switch -ax (Exclude archive filenames).
The Switch is
The Builder is |
I |
Command supports switch -x (Exclude filenames).
The Switch is
The Builder is |
I |
Command supports switch -spf/-spf2 (Use fully qualified file paths).
The Switch is
The Builder is |
I |
Command supports switch -ai (Include archive filenames).
The Switch is
The Builder is |
I |
Command supports switch -i (Include filenames).
The Switch is
The Builder is |
I |
Command supports switch -sns (NTFS alternate Streams).
The Switch is
The Builder is |
I |
Command supports switch -sni (NT security information).
The Switch is
The Builder is |
I |
Command supports switch -o (set Output directory).
The Switch is
The Builder is |
I |
Command supports switch -ao (Overwrite mode).
The Switch is
The Builder is |
I |
Command supports switch -p (set Password) .
The Switch is
The Builder is |
I |
Command supports switch -r (Recurse subdirectories).
The Switch is
The Builder is |
I |
Command supports switch -sfx (Create SFX archive).
The Switch is
The Builder is |
I |
Command supports switch -scrc (Set hash function).
The Switch is
The Builder is |
I |
Command supports switch -slt (Show technical information).
The Switch is
The Builder is |
I |
Command supports switch -stl (Set archive time-stamp from the most recently modified file).
The Switch is
The Builder is |
I |
Command supports switch -u (Update options).
The Switch is
The Builder is |
ISupportSwitchVolume |
Command supports switch -v (Create Volumes).
The Switch is
The Builder is |
I |
.
Command supports switch -w (Working directory).
The Switch is
The Builder is |
ISwitch | Base for all Switches. |
ITestOutput |
The parsed output of the TestCommand .
|