en-US/FarDescription.dll-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">
<command:details>
<command:name>Update-FarDescription</command:name>
<maml:description>
<maml:para>Removes descriptions of missing items.</maml:para>
</maml:description>
<command:verb>Update</command:verb>
<command:noun>FarDescription</command:noun>
</command:details>
<maml:description>
<maml:para>This cmdlet removes descriptions of missing files and folders from the description file. The description file is removed if it is empty after this update.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Update-FarDescription</maml:name>
<command:parameter required="false" position="0" >
<maml:name>Path</maml:name>
<command:parameterValue required="true">String</command:parameterValue>
</command:parameter>
<command:parameter required="false" position="named" >
<maml:name>Recurse</maml:name>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" position="0" >
<maml:name>Path</maml:name>
<maml:description>
<maml:para>Specifies the literal path of directory which description file is updated.</maml:para>
</maml:description>
</command:parameter>
<command:parameter required="false" position="named" >
<maml:name>Recurse</maml:name>
<maml:description>
<maml:para>Tells to process child directories recursively.</maml:para>
</maml:description>
</command:parameter>
</command:parameters>
</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">
<command:details>
<command:name>Sync-FarDescriptionSynopsis</command:name>
<maml:description>
<maml:para>Syncs synopses and descriptions.</maml:para>
</maml:description>
<command:verb>Sync</command:verb>
<command:noun>FarDescriptionSynopsis</command:noun>
</command:details>
<maml:description>
<maml:para>This cmdlet gets script synopses and sets them as file descriptions.
 
If a synopsis is empty or cannot be obtained for some reasons (syntax error) then the cmdlet writes a warning and does not change the existing description, if any.</maml:para>
</maml:description>
<command:syntax>
<command:syntaxItem>
<maml:name>Sync-FarDescriptionSynopsis</maml:name>
<command:parameter required="false" position="0" >
<maml:name>Path</maml:name>
<command:parameterValue required="true">String</command:parameterValue>
</command:parameter>
</command:syntaxItem>
</command:syntax>
<command:parameters>
<command:parameter required="false" position="0" >
<maml:name>Path</maml:name>
<maml:description>
<maml:para>Specifies the literal path of directory which description file is updated.</maml:para>
</maml:description>
</command:parameter>
</command:parameters>
</command:command>
</helpItems>