en-US/PSTrueCrypt-help.xml
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <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>Dismount-TrueCrypt</command:name> <command:verb>Dismount</command:verb> <command:noun>TrueCrypt</command:noun> <maml:description><maml:para>Dismounts a TrueCrypt container. </maml:para> </maml:description> </command:details> <maml:description><maml:para>In order to use this function, you must provide container settings that will be added to the local registry. You can add container settings via New-PSTrueCryptContainer. </maml:para> <maml:para>The default Alias name is: dmt </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Dismount-TrueCrypt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The name attribute value of the that was used in mounting the container. </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="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The name attribute value of the that was used in mounting the container. </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:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </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>C:\> Dismount-TrueCrypt -Name Kryptos</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PSTrueCrypt</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>Dismount-TrueCryptForceAll</command:name> <command:verb>Dismount</command:verb> <command:noun>TrueCryptForceAll</command:noun> <maml:description><maml:para>Dismounts all TrueCrypt and VeraCrypt containers. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Immediately dismounts all container(s) of TrueCrypt and VeraCrypt by invoking their exeutable with dismount parameter using no specified mount letter. </maml:para> <maml:para>The default Alias name is: dmt* </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Dismount-TrueCryptForceAll</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </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>C:\> Dismount-TrueCryptForceAll</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>C:\> dmt*</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PSTrueCrypt</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>Edit-PSTrueCryptContainer</command:name> <command:verb>Edit</command:verb> <command:noun>PSTrueCryptContainer</command:noun> <maml:description><maml:para>Edits a PSTrueCryptContainer in the registry with any of the following values: Name, Location, MountLetter, Product and Timestamp </maml:para> </maml:description> </command:details> <maml:description><maml:para>Edits a PSTrueCryptContainer in the registry with any of the following values: Name, Location, MountLetter, Product and Timestamp </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Edit-PSTrueCryptContainer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The existing name to reference this setting. If you want to </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>Location</maml:name> <maml:Description><maml:para>The TrueCrypt container's location. </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>MountLetter</maml:name> <maml:Description><maml:para>A preferred mount drive letter for this container. </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>Product</maml:name> <maml:Description><maml:para>Specifies if the container has been created with TrueCrypt or VeraCrypt. </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>Timestamp</maml:name> <maml:Description><maml:para>This switch will update the container's last write time. This is particularly useful when the container resides in a cloud storage service such as: 'Dropbox', 'Google Drive' or 'OneDrive'. </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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The existing name to reference this setting. If you want to </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>Location</maml:name> <maml:Description><maml:para>The TrueCrypt container's location. </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>MountLetter</maml:name> <maml:Description><maml:para>A preferred mount drive letter for this container. </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>Product</maml:name> <maml:Description><maml:para>Specifies if the container has been created with TrueCrypt or VeraCrypt. </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>Timestamp</maml:name> <maml:Description><maml:para>This switch will update the container's last write time. This is particularly useful when the container resides in a cloud storage service such as: 'Dropbox', 'Google Drive' or 'OneDrive'. </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:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </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>C:\> Edit-PSTrueCryptContainer Kriptos -Name Kryptos</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>C:\> Edit-PSTrueCryptContainer Kryptos -Location D:\Kryptos -MountLetter F -Timestamp</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PSTrueCrypt</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>Mount-TrueCrypt</command:name> <command:verb>Mount</command:verb> <command:noun>TrueCrypt</command:noun> <maml:description><maml:para>Mounts a TrueCrypt container. </maml:para> </maml:description> </command:details> <maml:description><maml:para>In order to use this function, you must provide container settings that will be added to the local registry. You can add container settings via New-PSTrueCryptContainer. </maml:para> <maml:para>The default Alias name is: mt </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Mount-TrueCrypt</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The name attribute value of the container settings that was added to the registry. Call Show-PSTrueCryptContainers to displayed all container settings. </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>KeyfilePath</maml:name> <maml:Description><maml:para>Any path(s) to keyfiles (or directories) if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type><maml:name>Array</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>Password</maml:name> <maml:Description><maml:para>If invoking this function in a background task, give value to this parameter to prevent function from prompting user for password. See the third example that is in this function's header comment. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type><maml:name>SecureString</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="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The name attribute value of the container settings that was added to the registry. Call Show-PSTrueCryptContainers to displayed all container settings. </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>KeyfilePath</maml:name> <maml:Description><maml:para>Any path(s) to keyfiles (or directories) if required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Array</command:parameterValue> <dev:type><maml:name>Array</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>Password</maml:name> <maml:Description><maml:para>If invoking this function in a background task, give value to this parameter to prevent function from prompting user for password. See the third example that is in this function's header comment. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type><maml:name>SecureString</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </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>C:\> Mount-TrueCrypt -Name Kryptos</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>C:\> Mount-TrueCrypt -Name Kryptos -KeyfilePath C:/Music/Courage.mp3</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> <command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>C:\> $SecurePassword = "123abc" | ConvertTo-SecureString -AsPlainText -Force C:\> Mount-TrueCrypt -Name Kryptos -KeyfilePath C:/Music/Courage.mp3 -Password $SecurePassword</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PSTrueCrypt</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>New-PSTrueCryptContainer</command:name> <command:verb>New</command:verb> <command:noun>PSTrueCryptContainer</command:noun> <maml:description><maml:para>Adds a new PSTrueCryptContainer in the registry with the following values: Name, Location, MountLetter, Product and Timestamp </maml:para> </maml:description> </command:details> <maml:description><maml:para>When invoked successfully, the container's: location, preferred mount drive letter, and name will be stored as a subkey in the HKCU:\Software\PSTrueCrypt registry key. If call for first time, PSTrueCrypt registry key will be created. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-PSTrueCryptContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>An arbitrary name to reference this setting when using Mount-TrueCrypt or Dismount-TrueCrypt. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>The TrueCrypt container's location. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>MountLetter</maml:name> <maml:Description><maml:para>A preferred mount drive letter for this container. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Product</maml:name> <maml:Description><maml:para>Specifies if the container has been created with TrueCrypt or VeraCrypt. </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>Timestamp</maml:name> <maml:Description><maml:para>This switch will update the container's last write time. This is particularly useful when the container resides in a cloud storage service such as: 'Dropbox', 'Google Drive' or 'OneDrive'. </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="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>An arbitrary name to reference this setting when using Mount-TrueCrypt or Dismount-TrueCrypt. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"><maml:name>Location</maml:name> <maml:Description><maml:para>The TrueCrypt container's location. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"><maml:name>MountLetter</maml:name> <maml:Description><maml:para>A preferred mount drive letter for this container. </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="true" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"><maml:name>Product</maml:name> <maml:Description><maml:para>Specifies if the container has been created with TrueCrypt or VeraCrypt. </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>Timestamp</maml:name> <maml:Description><maml:para>This switch will update the container's last write time. This is particularly useful when the container resides in a cloud storage service such as: 'Dropbox', 'Google Drive' or 'OneDrive'. </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:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </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>C:\> New-PSTrueCryptContainer -Name Kryptos -Location D:\Kryptos -MountLetter F -Product TrueCrypt</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PSTrueCrypt</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>Remove-PSTrueCryptContainer</command:name> <command:verb>Remove</command:verb> <command:noun>PSTrueCryptContainer</command:noun> <maml:description><maml:para>Remove settings that were added by the New-PSTrueCryptContainer function. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Remove the subkey in the HKCU:\Software\PSTrueCrypt registry, that contains the value of Name parameter. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-PSTrueCryptContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The name that is used to reference this setting for Mount-TrueCrypt or Dismount-TrueCrypt functions. </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="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The name that is used to reference this setting for Mount-TrueCrypt or Dismount-TrueCrypt functions. </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:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </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>C:\> Remove-PSTrueCryptContainer -Name Kryptos</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PSTrueCrypt</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>Remove-PSTrueCryptContainer</command:name> <command:verb>Remove</command:verb> <command:noun>PSTrueCryptContainer</command:noun> <maml:description><maml:para>Remove settings that were added by the New-PSTrueCryptContainer function. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Remove the subkey in the HKCU:\Software\PSTrueCrypt registry, that contains the value of Name parameter. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-PSTrueCryptContainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The name that is used to reference this setting for Mount-TrueCrypt or Dismount-TrueCrypt functions. </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="False" position="2" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>The name that is used to reference this setting for Mount-TrueCrypt or Dismount-TrueCrypt functions. </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:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </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>C:\> Remove-PSTrueCryptContainer -Name Kryptos</dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PSTrueCrypt</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>Show-PSTrueCryptContainers</command:name> <command:verb>Show</command:verb> <command:noun>PSTrueCryptContainers</command:noun> <maml:description><maml:para>Displays all settings for mounting and dismounting. </maml:para> </maml:description> </command:details> <maml:description><maml:para>When this parameterless function is called, a list is displayed in the command-line shell for all subkey registries under the HKCU:\Software\PSTrueCrypt registry key. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Show-PSTrueCryptContainers</maml:name> </command:syntaxItem> </command:syntax> <command:parameters></command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </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>C:\> Show-PSTrueCryptContainers Name Location MountLetter Product ---- -------- ----------- ------- brian C:\passwords X VeraCrypt verac D:\veracrypt V VeraCrypt lori D:\Documents H TrueCrypt 1pw F:\Google Drive\1pw Z TrueCrypt C:\></dev:code> <dev:remarks><maml:para> </maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://github.com/marckassay/PSTrueCrypt</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |