en-US/PS7Zip-help.xml
|
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Compress-7Zip</command:name> <command:verb>Compress</command:verb> <command:noun>7Zip</command:noun> <maml:description> <maml:para>Create a compressed archive of a file or folder</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use Compress-7Zip to create a 7z, gzip, zip, bzip2 or tar archive.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Compress-7Zip</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>FullName</maml:name> <maml:Description> <maml:para>The full path of the file or folder you would like turn into a compressed archive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFile</maml:name> <maml:Description> <maml:para>The full path of the file to be created. Defaults to archive.zip in current working directory.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ArchiveType</maml:name> <maml:Description> <maml:para>The type of archive you would like. Valid types 7Z, GZIP, ZIP, BZIP2, TAR.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Remove</maml:name> <maml:Description> <maml:para>If $True this will remove the uncompressed version of the file or folder only leaving the compressed archive.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>FullName</maml:name> <maml:Description> <maml:para>The full path of the file or folder you would like turn into a compressed archive.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputFile</maml:name> <maml:Description> <maml:para>The full path of the file to be created. Defaults to archive.zip in current working directory.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ArchiveType</maml:name> <maml:Description> <maml:para>The type of archive you would like. Valid types 7Z, GZIP, ZIP, BZIP2, TAR.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Remove</maml:name> <maml:Description> <maml:para>If $True this will remove the uncompressed version of the file or folder only leaving the compressed archive.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Compress-7Zip c:\scripts</dev:code> <dev:remarks> <maml:para>Create archive.zip in the current working folder of the folder c:\scripts</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Compress-7Zip "computer inventory.csv" -OutputFile "inventory.gz" -ArchiveType GZIP -Remove $True</dev:code> <dev:remarks> <maml:para>Create a gzip archive of a single file and delete the uncompressed file</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-ChildItem E:\test | Where {$_.LastWriteTime -lt (Get-Date).AddDays(-5)} | Select -First 1 | Compress-7Zip</dev:code> <dev:remarks> <maml:para>Create an archive in c:\folder based on pipeline input</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://gavineke.com/PS7Zip/Compress-7Zip</maml:linkText> <maml:uri>http://gavineke.com/PS7Zip/Compress-7Zip</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Expand-7Zip</command:name> <command:verb>Expand</command:verb> <command:noun>7Zip</command:noun> <maml:description> <maml:para>Extract contents of a compressed archive file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use Expand-7Zip to extract the contents of an archive.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Expand-7Zip</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>FullName</maml:name> <maml:Description> <maml:para>The full path of the compressed archive file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Remove</maml:name> <maml:Description> <maml:para>If $True this will remove the compressed version of the file only leaving the uncompressed contents.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>FullName</maml:name> <maml:Description> <maml:para>The full path of the compressed archive file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Remove</maml:name> <maml:Description> <maml:para>If $True this will remove the compressed version of the file only leaving the uncompressed contents.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Expand-7Zip archive.zip</dev:code> <dev:remarks> <maml:para>Extract contents of archive.zip in the current working folder</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Expand-7Zip "c:\folder\files.gz"</dev:code> <dev:remarks> <maml:para>Extract contents of c:\folder\files.gz into current working folder</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://gavineke.com/PS7Zip/Expand-7Zip</maml:linkText> <maml:uri>http://gavineke.com/PS7Zip/Expand-7Zip</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-7Zip</command:name> <command:verb>Get</command:verb> <command:noun>7Zip</command:noun> <maml:description> <maml:para>List contents of a compressed archive file</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Use Get-7Zip to list the contents of an archive.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-7Zip</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>FullName</maml:name> <maml:Description> <maml:para>The full path of the compressed archive file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>FullName</maml:name> <maml:Description> <maml:para>The full path of the compressed archive file.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title> <dev:code>Get-7Zip archive.zip</dev:code> <dev:remarks> <maml:para>List contents of archive.zip in the current working folder</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Get-7Zip "c:\folder\files.gz"</dev:code> <dev:remarks> <maml:para>List contents of c:\folder\files.gz</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>http://gavineke.com/PS7Zip/Get-7Zip</maml:linkText> <maml:uri>http://gavineke.com/PS7Zip/Get-7Zip</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |