GetCowsay.dll-Help.xml
|
<helpItems 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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-Cowsay</command:name> <maml:description> <maml:para>This cmdlet generates ASCII pictures of a cow with a message.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>Cowsay</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Cowsay</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>mode</maml:name> <maml:description> <maml:para>Preset faces to select for the cow.</maml:para> <maml:para>Will override any eyes or tongue settings set manually.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>list</maml:name> <maml:description> <maml:para>List available cow files in module cows folder.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>figlet</maml:name> <maml:description> <maml:para>Enable figlet mode for your message.</maml:para> <maml:para>Must escape special characters in order to work properly.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>eyes</maml:name> <maml:description> <maml:para>Eyes for the cow, cannot be more than 2 characters long. If more than 2 characters long, will be cut off.</maml:para> <maml:para>Overridden by the mode parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tongue</maml:name> <maml:description> <maml:para>Tongue for the cow, cannot be more than 2 characters long. If more than 2 characters long, will be cut off.</maml:para> <maml:para>Overridden by the mode parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cowfile</maml:name> <maml:description> <maml:para>Specify either a specific cowfile found under the Module cows folder or a specific cowfile in a specific directory.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wrapcolumn</maml:name> <maml:description> <maml:para>Change the width of the speech bubble. Cannot be less than 10 characters or more than 76 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>think</maml:name> <maml:description> <maml:para>Make the cow think.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>message</maml:name> <maml:description> <maml:para>What the cow says.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>mode</maml:name> <maml:description> <maml:para>Preset faces to select for the cow.</maml:para> <maml:para>Will override any eyes or tongue settings set manually.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>list</maml:name> <maml:description> <maml:para>List available cow files in module cows folder.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>figlet</maml:name> <maml:description> <maml:para>Enable figlet mode for your message.</maml:para> <maml:para>Must escape special characters in order to work properly.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>eyes</maml:name> <maml:description> <maml:para>Eyes for the cow, cannot be more than 2 characters long. If more than 2 characters long, will be cut off.</maml:para> <maml:para>Overridden by the mode parameter.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>tongue</maml:name> <maml:description> <maml:para>Tongue for the cow, cannot be more than 2 characters long. If more than 2 characters long, will be cut off.</maml:para> <maml:para>Overridden by the mode parameter.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>cowfile</maml:name> <maml:description> <maml:para>Specify either a specific cowfile found under the Module cows folder or a specific cowfile in a specific 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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>wrapcolumn</maml:name> <maml:description> <maml:para>Change the width of the speech bubble. Cannot be less than 10 characters or more than 76 characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri/> </dev:type> <dev:defaultValue>40</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>think</maml:name> <maml:description> <maml:para>Make the cow think.</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></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>message</maml:name> <maml:description> <maml:para>What the cow says.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> <maml:description/> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors></command:terminatingErrors> <command:nonTerminatingErrors></command:nonTerminatingErrors> <maml:alertSet> <maml:title></maml:title> <maml:alert> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$message = 'Four score and seven years ago our fathers brought forth on this continent, a new nation, conceived in Liberty, and dedicated to the proposition that all men are created equal.' Get-Cowsay -message $message</dev:code> <dev:remarks> <maml:para>If you only speicfy the message parameter you will get a cow with a speech bubble 40 characters wide.</maml:para> <maml:para /> <maml:para /> <maml:para># _______________________________________ # / Four score and seven years ago our \ # | fathers brought forth on this | # | continent, a new nation, conceived in | # | Liberty, and dedicated to the | # | proposition that all men are created | # \ equal. / # --------------------------------------- # # \ ^__^ # \ (oo)\_______ # (__)\ )\/\ # ||----w | # || ||</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$message = 'Four score and seven years ago our fathers brought forth on this continent, a new nation, conceived in Liberty, and dedicated to the proposition that all men are created equal.' Get-Cowsay -wrapcolumn 20 -message $message</dev:code> <dev:remarks> <maml:para>If you call the wrapcolumn paramter with a value less than 40 along with the message parameter you will get a cow with a speech bubble n characters in width.</maml:para> <maml:para /> <maml:para /> <maml:para># ___________________ # / Four score and \ # | seven years ago | # | our fathers | # | brought forth on | # | this continent, a | # | new nation, | # | conceived in | # | Liberty, and | # | dedicated to the | # | proposition that | # | all men are | # \ created equal. / # ------------------- # # \ ^__^ # \ (oo)\_______ # (__)\ )\/\ # ||----w | # || ||</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$message = 'Four score and seven years ago our fathers brought forth on this continent, a new nation, conceived in Liberty, and dedicated to the proposition that all men are created equal.' Get-Cowsay -wrapcolumn 60 -message $message</dev:code> <dev:remarks> <maml:para>If you call the wrapcolumn paramter with a value greater than 40 along with the message parameter you will get a cow with a speech bubble n characters in width.</maml:para> <maml:para /> <maml:para /> <maml:para># _____________________________________________________________ # / Four score and seven years ago our fathers brought forth on \ # | this continent, a new nation, conceived in Liberty, and | # | dedicated to the proposition that all men are created | # \ equal. / # ------------------------------------------------------------- # # \ ^__^ # \ (oo)\_______ # (__)\ )\/\ # ||----w | # || ||</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$message = 'What was I thinking!?' Get-Cowsay -think -message $message</dev:code> <dev:remarks> <maml:para>If you call the think paramter along with the message parameter you will get a cow with a think bubble instead of a speech bubble.</maml:para> <maml:para /> <maml:para /> <maml:para># _______________________ # ( What was I thinking!? ) # ----------------------- # o ^__^ # o (oo)\_______ # (__)\ )\/\ # ||----w | # || ||</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$message = 'Resistance is Mootile!' Get-Cowsay -mode borg -message $message</dev:code> <dev:remarks> <maml:para>If you call the mode paramter, with a value, along with the message parameter your cows Eyes and Tongue will change according to the mode you speicfied.</maml:para> <maml:para /> <maml:para /> <maml:para># ________________________ # < Resistance is Mootile! > # ------------------------ # \ ^__^ # \ (==)\_______ # (__)\ )\/\ # ||----w | # || ||</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 6 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$message = 'Stars in my eyes!' Get-Cowsay -eyes ** -tongue ' U' -message $message</dev:code> <dev:remarks> <maml:para>If you call the Eyes and/or Tongue paramter(s), with a value, along with the message parameter your cows Eyes and Tongue will change according to the values you specified.</maml:para> <maml:para /> <maml:para /> <maml:para># ___________________ # < Stars in my eyes! > # ------------------- # \ ^__^ # \ (**)\_______ # (__)\ )\/\ # U ||----w | # || ||</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 7 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$message = 'Brrrrrrr!' Get-Cowsay -cowfile tux -message $message</dev:code> <dev:remarks> <maml:para>If you call the cowfile paramter, with a value, along with the message parameter you will get the ascii art associated with that value.</maml:para> <maml:para>To see a list of available cowfile values use Get-Cowsay -list.</maml:para> <maml:para /> <maml:para /> <maml:para># ___________ # < Brrrrrrr! > # ----------- # \ # \ # .--. # |o_o | # |:_/ | # // \ \ # (| | ) # /'\_ _/`\ # \___)=(___/</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 8 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$directory = (get-location).path $message = 'Hippity Hoppity Easter is on the way!' Get-Cowsay -cowfile $directory\bunny -message $message</dev:code> <dev:remarks> <maml:para>If you call the cowfile paramter, with a full path to a cowfile, along with the message parameter you will get the ascii art associated with that cowfile.</maml:para> <maml:para /> <maml:para /> <maml:para># _______________________________________ # < Hippity Hoppity Easter is on the way! > # --------------------------------------- # \ # \ \ # \ /\ # ( ) # .( o ).</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 9 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$message = @" _ _ _ _ _ _ | (_) | _____ | |_| |__ (_)___ | | | |/ / _ \ | __| '_ \| / __| | | | < __/ | |_| | | | \__ \ |_|_|_|\_\___| \__|_| |_|_|___/ "@ Get-Cowsay -figlet -message $message</dev:code> <dev:remarks> <maml:para>If you call the figlet paramter you can specify a figlet for your message.</maml:para> <maml:para>It is recommended you store your figlet in a Here-String variable and pass that variable to your message.</maml:para> <maml:para /> <maml:para /> <maml:para># __________________________________ # / _ _ _ _ _ _ \ # | | (_) | _____ | |_| |__ (_)___ | # | | | | |/ / _ \ | __| '_ \| / __| | # | | | | < __/ | |_| | | | \__ \ | # \ |_|_|_|\_\___| \__|_| |_|_|___/ / # ---------------------------------- # # \ ^__^ # \ (oo)\_______ # (__)\ )\/\ # ||----w | # || ||</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 10 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$message = @" . oooo o8o .o8 ``888 ``"' .ooooo. oooo d8b .o888oo 888 .oo. oooo .oooo.o d88' ``88b ``888""8P 888 888P"Y88b ``888 d88( "8 888 888 888 888 888 888 888 ``"Y88b. 888 888 888 888 . 888 888 888 o. )88b ``Y8bod8P' d888b "888" o888o o888o o888o 8""888P' "@ Get-Cowsay -figlet -message $message</dev:code> <dev:remarks> <maml:para>If you call the figlet paramter you can specify a figlet for your message.</maml:para> <maml:para>It is recommended you store your figlet in a Here-String variable and pass that variable to your message.</maml:para> <maml:para>If your figlet has special characters, such as the tick(`) character, you must escape the special character as seen in the example.</maml:para> <maml:para /> <maml:para /> <maml:para># ___________________________________________________________ # / . oooo o8o \ # | .o8 `888 `"' | # | .ooooo. oooo d8b .o888oo 888 .oo. oooo .oooo.o | # | d88' `88b `888""8P 888 888P"Y88b `888 d88( "8 | # | 888 888 888 888 888 888 888 `"Y88b. | # | 888 888 888 888 . 888 888 888 o. )88b | # \ `Y8bod8P' d888b "888" o888o o888o o888o 8""888P' / # ----------------------------------------------------------- # # \ ^__^ # \ (oo)\_______ # (__)\ )\/\ # ||----w | # || ||</maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>PowerShell Gallery - CowsaySharp</maml:linkText> <maml:uri>https://www.powershellgallery.com/packages/CowsaySharp/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>CodePlex Project - CowsaySharp</maml:linkText> <maml:uri>https://cowsaysharp.codeplex.com/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>GitHub Project - CowsaySharp</maml:linkText> <maml:uri>https://github.com/terrytrent/CowsaySharp</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>GitHub Project - Original Cowsay</maml:linkText> <maml:uri>https://github.com/piuccio/cowsay</maml:uri> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |