From d487ff9e627c8a6a7bd74b4ee0faedb8a4896fd5 Mon Sep 17 00:00:00 2001 From: Aditya Patwardhan Date: Fri, 31 Aug 2018 14:32:54 -0700 Subject: [PATCH] Change locale of mdspell to en-US (#7671) Update the locale to use en-us for mdspell checker. --- .spelling | 1635 +++++++---------- .travis.yml | 2 +- .../powershell-beginners-guide.md | 70 +- 3 files changed, 704 insertions(+), 1003 deletions(-) diff --git a/.spelling b/.spelling index 107f7ffe7f..8fd00e4c3e 100644 --- a/.spelling +++ b/.spelling @@ -3,235 +3,23 @@ # global dictionary is at the start, file overrides afterwards # one word per line, to define a file override use ' - filename' # where filename is relative to this configuration file - -#region Global Dictionary +0-powershell-crossplatform +0xfeeddeadbeef +100ms 2ae5d07 -2.x -2.x. +32-bit +64-bit +about_ +about_debuggers +about_jobs acl -ActiveDirectory +add-localgroupmember +add-ons +adelton +adhoc aditya adityapatwardhan -alpha.15 -alpha.7 -alpha.8 -alpha.9 -AlternateStream -amd64 -analyzing -AppImage -AppVeyor -argumentlist -arm32 -arm64 -artifact -artifacts -ASP.NET -AssemblyLoadContext -authenticode -authenticodesignature -behavior -behaviors -beta.7 -booleans -catalog -cataloged -CentOS -childitem -chucklu -cimsession -cimsupport -cmake -cmd -cmdlet -cmdlets -codecov.io -color -colors -comobject -config -ConsoleHost -ConvertFrom-Json -convertto-xml -CoreCLR -CoreFX -credssp -crontab -crossgen -cs -CsPhysicallyInstalledMemory -debughandler -DevOps -DockerFile -DockerFiles -DotNetCore -DottedScopes -eBook -enum -env -ergo3114 -exe -favor -favorite -frontload -FullCLR -functionprovider -Get-Acl -Get-AuthenticodeSignature -Get-ChildItem -Get-ComputerInfo -Get-PSSessionConfiguration -Get-WinEvent -github -hashtable -hashtables -helpproviderwithcache -helpproviderwithfullcache -helpsystem -homebrew -hotfix -httpbin.org -HttpBin's -ifdef'ed -ilya -init -Invoke-RestMethod -Invoke-WebRequest -isnot -json -korygill -labeled -linux-x64 -lockfile -macOS -md -microsoft -Microsoft.PowerShell.Archive -microsoft.powershell.commands.diagnostics -microsoft.powershell.commands.management -microsoft.powershell.commands.utility -microsoft.powershell.consolehost -microsoft.powershell.coreclr.assemblyloadcontext -microsoft.powershell.coreclr.eventing -microsoft.powershell.psreadline -microsoft.powershell.security -microsoft.wsman.management -microsoft.wsman.runtime -MSBuild -MS-PSRP -Multipart -myget -namedpipe -New-PSSessionOption -New-PSTransportOption -notcontains -nuget -NuGet -NUnit -nunit -nupkg -nuspec -OpenCover -OpenSSH -OpenSUSE -PackageManagement -param -parameterized -patwardhan -powershell -PowerShell -PowerShell.Core.Instrumentation -powershell.exe -PowerShellGet -program.cs -ProgramFiles -ProxyCommand -ps1 -PSCredential -PSObject -psobjects -psproxyjobs -PSReadline -psrp.windows -PSSessionConfiguration -pwsh -redistributables -Register-EngineEvent -Register-PSSessionConfiguration -registryprovider -remoting -ResGen -resx -RFCs -runas -Runspace -runtimes -sarithsutha -savehelp -sazonov -SecureString -sessionstatecontainer -sessionstateitem -Set-Acl -Set-AuthenticodeSignature -Set-ExecutionPolicy -ShouldBeErrorId -showcommandinfo -Singleline -snapin -ssh -StackOverflow -submodule -submodules -sudo -system.management.automation -TeamCity -thenewstellw -throttlelimit -toolset -toolchain -TraceSource -Unregister-Event -Unregister-PSSessionConfiguration -utils -utils.cs -vscode -walkthrough -WebCmdlets -wget -whitespace -Win32 -win7 -WinRM -WiX -writingpestertests.md -WSMan -wsmansessionoption.cs -xUnit -0-powershell-crossplatform -ReportGenerator -#endregion - -#region ./tools/install-powershell.readme.md Overrides - - ./tools/install-powershell.readme.md -includeide -sed -#endregion - -#region CHANGELOG.md Overrides - - CHANGELOG.md -_ -_Jobs --Command --Exclude --File --Include --Title -0xfeeddeadbeef -about_ -about_Jobs -acceptance -adelton +aiello alexandair alexjordan6 alpha.10 @@ -239,13 +27,33 @@ alpha.11 alpha.12 alpha.13 alpha.14 +alpha.15 alpha.16 alpha.17 alpha.18 -AppLocker +alpha.7 +alpha.8 +alpha.9 +alternatestream +amd64 +andschwa +api +apis +appimage +applocker +appveyor args -Auth -behavioral +argumentlist +arm32 +arm64 +asp.net +assemblyloadcontext +authenticodesignature +azurerm.netcore.preview +azurerm.profile.netcore.preview +azurerm.resources.netcore.preview +backgrounded +backgrounding bergmeister beta.1 beta.2 @@ -253,865 +61,732 @@ beta.3 beta.4 beta.5 beta.6 +beta.7 beta.8 beta.9 beta2 Bhaal22 -binding bjh7242 bool +breakpoint brianbunke -CallmeJoeBob -CDXML +brucepay +bugfix +build.json +build.psm1 +bulid +callmejoebob +catchable +cdxml +celsius +CentOS +changelog +changelog.md +changeset +changesets +channel9 charset -CI -cleanup -CloudyDino -CodeFactor -CodeMethod -CodeOwner +checkbox +checksum +childitem +cimsession +cimsupport +classlib +clear-itemproperty +cloudydino +cls +cmake +cmd +cmdlet +cmdletproviderclasses +cmdlets +codebase +codecov.io +codecoverage.zip +codefactor +codeowner codepage -CommandNotFoundException -ContentType -ConvertTo-Html -CoreConsoleHost +commanddiscovery +commandsearch +comobject +config +connect-pssession +consolehost +consolehostrunspaceinit +consolehostuserinterface +consolelineoutput +contenttype +convertfrom-csv +convertfrom-json +convertfrom-sddlstring +convertfrom-securestring +convertfrom-stringdata +convertto-csv +convertto-html +convertto-json +convertto-securestring +convertto-xml +copy-itemproperty +coreclr +coreconsolehost +corefx +CorePsAssemblyLoadContext.cs +coveralls.exe +coveralls.io. +coveralls.net +credssp +cron +crontab +crossgen crossgen'ing -DarqueWarrior -DarwinJS +csharp +csmacnz +csphysicallyinstalledmemory +ctrl +darquewarrior +darwinjs +daxian-dbw +dayofweek dchristian3188 -DdWr +ddwr +debughandler +dee-see deserialization deserialize +dest +dest.txt +dev devblackops -DeviceGuard +deviceguard +devops diddledan +disable-localuser +disable-psbreakpoint +disable-pstrace +disable-pswsmancombinedtrace +disable-runspacedebug +disable-wsmantrace +disconnect-pssession +displaydataquery +distro +distros +dlls dlwyatt -Dockerfile +dockerbasedbuild +dockerfile +dockerfiles +dongbo +don'ts +dotcover dotnet +dotnetcore +dottedscopes +downlevel +dropdown +e.g. +ebook +ebooks +enable-localuser +enable-psbreakpoint +enable-pstrace +enable-pswsmancombinedtrace +enable-runspacedebug +enable-wsmantrace +encodings +enter-pshostprocess +enter-pssession +enum enums -EXE's -ExecutionPolicy +ergo3114 +errorrecord +etl +excludeversion +exe +executables +executionpolicy +exit-pshostprocess +exit-pssession +export-binarymilog +export-clixml +export-csv +export-formatdata +export-modulemember +failurecode +failurecount ffeldhaus -FileCatalog -FilterHashtable +filecatalog +filename +filesystem +filesystemprovider +filterhashtable +find-dscresource +find-packageprovider +find-rolecapability +firefox +folderName foreach +formatfileloading +formatviewbinding +frontload +fullclr +functionprovider gabrielsroka -GetParentProcess -GitCommitId +gamified +gc.regions.xml +get-apachemodule +get-apachevhost +get-childitem +get-cimassociatedinstance +get-cimclass +get-ciminstance +get-computerinfo +get-cronjob +get-eventsubscriber +get-filehash +get-formatdata +get-installedmodule +get-installedscript +get-itemproperty +get-itempropertyvalue +get-localgroup +get-localgroupmember +get-localuser +get-logproperties +get-packageprovider +get-packagesource +getparentprocess +get-psbreakpoint +get-pscallstack +get-pshostprocessinfo +get-psprovider +get-psreadlinekeyhandler +get-psreadlineoption +get-psrepository +get-pssession +get-pssessioncapability +get-runspacedebug +get-systemdjournal +gettype +get-typedata +get-uiculture +get-winevent +get-wsmaninstance +gitcommitid +github +githug +gitter globbing -HelpersCommon.psm1 -Himura2la -honors +GoogleTest +gzip +hashtable +helloworld.ps1 +helpproviderwithcache +helpproviderwithfullcache +helpsystem +hemant +hemantmahawar +himura2la +homebrew hostname +hotfix +httpbin.org +httpbin's +https hubuk -IISResetMe -IncludeUserName -InformationRecord +i.e. +ifdef'ed +iisresetme +ilya +import-binarymilog +import-clixml +import-csv +import-localizeddata +import-packageprovider +import-powershelldatafile +includeide +includeusername +informationrecord +initializers +install-packageprovider +interactivetesting interop -IoT -iSazonov -IsCore -IsCoreCLR +interoperation +invoke-cimmethod +invoke-restmethod +invoke-wsmanaction +iot +isazonov +iscore +iscoreclr +isnot +itemtype +itpro +jameswtruher jazzdelightsme jeffbi +jen joandrsn +joeyaiello jokajak -JoshuaCooper -JsonConfigFileAccessor -Jumplist +joshuacooper +journalctl +jpsnover +json +jsonconfigfileaccessor +judgement +jumplist kanjibates kasper3 -KevinMarquette -KeyFileParameter -KeyHandler -KirkMunro +katacoda +kevinmarquette +keyfileparameter +keyhandler +khansen00 +kirkmunro kittholland +korygill +kpis kvprasoon kwiknick kwkam kylesferrazza -LDSpits -Lee303 +labelling +lastwritetime +launch.json +ldspits +lee303 +libpsl libpsl-native libunwind8 -LoadFrom +locationglobber +loopback +lossless louistio +lynda.com +lzybkr mababio -maertendMSFT +macos +maertendmsft +mahawar markekraus mcbobke -Meir017 -meta -MiaRomero -Microsoft.Management.Infrastructure.Native -Microsoft.PowerShell.LocalAccounts +md +meir017 +memberresolution +messageanalyzer +metadata +miaromero +microsoft +microsoft.com +microsoft.management.infrastructure.native +microsoft.powershell.archive +microsoft.powershell.commands.diagnostics +microsoft.powershell.commands.management +microsoft.powershell.commands.utility +microsoft.powershell.consolehost +microsoft.powershell.core +microsoft.powershell.coreclr.assemblyloadcontext +microsoft.powershell.coreclr.eventing +microsoft.powershell.diagnostics +microsoft.powershell.localaccounts +microsoft.powershell.management +microsoft.powershell.psreadline +microsoft.powershell.security +microsoft.powershell.utility +microsoft.wsman.management +microsoft.wsman.runtime +mirichmo +mkdir mklement0 +move-itemproperty +msbuild +mshsnapinloadunload +msi +ms-psrp +multiline +multipart +mv +mvps mwrock -NanoServer -nanoserver-insider +myget +namedpipe +namespace +nano +nanoserver +nativeexecution +netip.ps1. +netstandard.dll +new-apachevhost +new-ciminstance +new-cimsessionoption +new-cronjob +new-guid +new-itemproperty +new-localgroup +new-localuser +new-modulemanifest +new-psrolecapabilityfile +new-pssession +new-pssessionconfigurationfile +new-pssessionoption +new-pstransportoption +new-scriptfileinfo +new-temporaryfile +new-timespan +new-winevent +new-wsmaninstance +new-wsmansessionoption non-22 -non-CIM -non-R2 -OAuth +non-cim +non-https +non-r2 +noresume +notcontains +nuget +nuget.exe +numberbytes +nupkg +oauth offthewoll oising +omi +omnisharp oneget.org -Patochun -Pawamoy -PetSerAl +opencover +opencover.zip +openssh +openssl +opensuse +oss +p1 +packagemanagement +parameterbinderbase +parameterbindercontroller +parameterbinding +pathresolution +patochun +patwardhan +paulhigin +pawamoy +payette +perfview +perfview.exe +petseral +plaintext +pluggable +pluralsight +poshcode +powerbi powercode -PowerShell.6 -PowershellNinja -PowerShellProperties +powershell +powershell.6 +powershell.com +powershell.core.instrumentation +powershell.org +powershellcore +powershellgallery +powershellget +powershellmagazine.com +powershellninja +powershellproperties +powershell-unix ppadmavilasom +pre-build +pre-compiled +pre-generated +pre-installed +prepend +preprocessor +pre-release +pre-releases +pre-requisites preview.1 preview.2 preview.3 preview.4 preview1-24530-04 -ProductVersion -PRs -PSDrive -PseudoParameterBinder -PSGallery -PSReadLine -PSScriptAnalyzer -PSVersion -PVS-Studio -Pwrshplughin.dll +productversion +program.cs +providername +proxycommand +ps1 +ps1xml +pscredential +psd1 +psdrive +psdriveinfo +pseudoparameterbinder +psgallery +psm1 +psobject +psobjects +psproxyjobs +psreadline +psrp.windows +psscriptanalyzer +pssessionconfiguration +pssnapinloadunload +pssnapins +psversion +psversiontable +pvs-studio +pwd +pwrshplughin.dll +pwsh qmfrederik raghav710 -Raspbian +raspbian rc rc.1 rc.2 rc2-24027 rc3-24011 -README.md +readme +readme.md readonly -RedHat -RelationLink +rebase +rebasing +receive-pssession +recurse +reddit +redhat +redistributable +redistributables +register-argumentcompleter +register-cimindicationevent +register-engineevent +register-objectevent +register-packagesource +register-psrepository +registryprovider +relationlink +remotesigned +remoting +remove-ciminstance +remove-cronjob +remove-itemproperty +remove-localgroup +remove-localgroupmember +remove-localuser +remove-psbreakpoint +remove-psreadlinekeyhandler +remove-pssession +remove-typedata +remove-wsmaninstance +rename-itemproperty +rename-localgroup +rename-localuser +repo +reportgenerator +resgen +responseheaders +rest.ps1 +restart-apachehttpserver +resx richardszalay +Rin rkeithhill -Robo210 +robo210 +ronn rpalo +runspace +runspaceinit +runtime +runtimes +sample-dotnet1 +sample-dotnet2 +sarithsutha +savehelp +sazonov +schvartzman +schwartzmeyer +securestring seemethere -SemVer +select-xml +semver +sessionid +sessionstate +sessionstatecontainer +sessionstateitem +set-ciminstance sethvs -shebang -ShellExecute -showwindow -SimonWahlin -Stanzilla -startup -startuptype +set-itemproperty +set-localgroup +set-localuser +set-logproperties +set-packagesource +set-psbreakpoint +set-psdebug +set-psreadlinekeyhandler +set-psreadlineoption +set-psrepository +set-strictmode +set-wsmaninstance +set-wsmanquickconfig +shellexecute +shouldbeerrorid +showcommandinfo +simonwahlin +singleline +smes +snapcraft +snapin +snover +sometext +source.txt +src +ss64.com +stackoverflow +stanzilla +start-codecoveragerun stdin +stevel-msft stknohg strawgate -StringBuilder +streamdescribecifeaturescenariodescribecontextitcontextcontextbeforeallafterallbeforeeachaftereachshould +stringbuilder stuntguy3000 -SwarfegaGit -SxS +submodule +submodules +sudo +superproject +swarfegagit +sxs +symlink +symlinks +syscall +syslog system.manage -Tadas +system.management.automation +systemd +tabcompletion +tadas tandasat -TestCase -TheFlyingCorpse +test.ps1 +test.txt. +test1.txt +test2.txt +testcase +testdrive +test-modulemanifest +test-pssessionconfigurationfile +tests.zip +test-scriptfileinfo +tgz +theflyingcorpse +thenewstellw thezim -ThreadJob -TimCurwick +threadjob +throttlelimit +throw-testcasesitmockdescribe +timcurwick timestamp -TimeZone timothywlewis +-title tomconte -TPA -Travis +toolchain +toolset +tracesource +travisez13 travisty -TTY's +truher +typecataloggen +typeconversion +typegen +typematch +unregister-event +unregister-packagesource +unregister-psrepository +unregister-pssessionconfiguration un-versioned -UserAgent -UserData -UserVoice -Utf8 -UTF8NoBOM +update-formatdata +update-modulemanifest +update-scriptfileinfo +update-typedata +uri +userdata +uservoice +utf8 +utf-8 +utf8nobom +utils +utils.cs v0.1.0 v0.2.0 v0.3.0 v0.4.0 v0.5.0 v0.6.0 +v141 +v3 v4 +v5.0 +v6 +v6.0. v6.0.0 v6.0.1 v6.0.2 v6.1.0 -ValidateNotNullOrEmpty -VisualStudio +validatenotnullorempty +versioned +versioning +visualstudio +vorobev vors -WebListener -WebRequest +vscode +vstsbuild.ps1 +walkthrough +webcmdlets +weblistener +webrequest wesholton84 +wget +whitespace +wildcard wildcarded -win7-x86 -Windos -WindowsVersion -WSManCredSSP -XPath -Youtube -XML -zackJKnight -#endregion - -#region CODE_OF_CONDUCT.md Overrides - - CODE_OF_CONDUCT.md -microsoft.com -o -opencode -#endregion - -#region demos/Apache/readme.md Overrides - - demos/Apache/readme.md -Get-ApacheModule -Get-ApacheVHost -New-ApacheVHost -Restart-ApacheHTTPserver -#endregion - -#region demos/Azure/README.md Overrides - - demos/Azure/README.md -AzureRM.NetCore.Preview -AzureRM.Profile.NetCore.Preview -AzureRM.Resources.NetCore.Preview -ExcludeVersion -ProviderName -#endregion - -#region demos/crontab/README.md Overrides - - demos/crontab/README.md -DayOfWeek -Get-CronJob -New-CronJob -Remove-CronJob -u -#endregion - -#region demos/DSC/readme.md Overrides - - demos/DSC/readme.md -www.github.com -omi -#endregion - -#region demos/python/README.md Overrides - - demos/python/README.md -_script.ps1 -_script.ps1. -#endregion - -#region demos/rest/README.md Overrides - - demos/rest/README.md -rest.ps1 -#endregion - -#region demos/SystemD/readme.md Overrides - - demos/SystemD/readme.md -Get-SystemDJournal -journalctl -SystemD -#endregion - -#region demos/WindowsPowerShellModules/README.md Overrides - - demos/WindowsPowerShellModules/README.md -PowerShellGallery -PSSnapins -WindowsPSModulePath -#endregion - -#region docker/README.md Overrides - - docker/README.md -andschwa's -CurrentUser -hub.docker.com -NanoServer-Insider -nanoserver-insider-powershell -#endregion - -#region docs/building/internals.md Overrides - - docs/building/internals.md -Catalog -flavor -libpsl -MSBuild -nuget.exe -plugin -powershell-unix -src -v141 -x64_arm -x64_arm64 -msbuild -#endregion - -#region docs/building/macos.md Overrides - - docs/building/macos.md -preview3 -#endregion - -#region docs/cmdlet-example/command-line-simple-example.md Overrides -- docs/cmdlet-example/command-line-simple-example.md -aka -classlib -dotnet -netstandard.dll +wildcards +win32 +win32-openssh +win7 +windos +windowspsmodulepath +windowsversion +winrm +wix +wpr +wprui.exe +writingpestertests.md wsl -#endregion - -#region docs/cmdlet-example/visual-studio-simple-example.md Overrides -- docs/cmdlet-example/visual-studio-simple-example.md -dropdown -v3 -#endregion - -#region docs/community/governance.md Overrides - - docs/community/governance.md -Aiello -AngelCalvo -BrucePay -Calvo -daxian-dbw -Dongbo -DON'Ts -Hemant -HemantMahawar -JamesWTruher -joeyaiello -jpsnover -khansen00 -lzybkr -Mahawar -Payette -PRs -Snover -SteveL-MSFT -Truher -#endregion - -#region docs/debugging/README.md Overrides +wsman +wsmancredssp +wsmansessionoption.cs +www.github.com +x64 +x86 +xpath +xunit +youtube +zackjknight + - CHANGELOG.md +chucklu +honour - docs/debugging/README.md -CmdletProviderClasses -CommandDiscovery -CommandSearch -ConsoleHostRunspaceInit -ConsoleHostUserInterface -ConsoleLineOutput corehost -DisplayDataQuery -FileSystemProvider -FormatFileLoading -FormatViewBinding -LocationGlobber -MemberResolution -MshSnapinLoadUnload -OmniSharp -ParameterBinderBase -ParameterBinderController -ParameterBinding -PathResolution -PSDriveInfo -PSSnapInLoadUnload -RunspaceInit -SessionState -TypeConversion -TypeMatch -XTerm -#endregion - -#region docs/dev-process/breaking-change-contract.md Overrides - - docs/dev-process/breaking-change-contract.md -cd -cdxml -int -p1 -#endregion - -#region docs/dev-process/coding-guidelines.md Overrides - - docs/dev-process/coding-guidelines.md -interop -PaulHigin -SMEs -TravisEz13 -uppercase -#endregion - -#region docs/FAQ.md Overrides - - docs/FAQ.md -PoshCode -SS64.com -TypeGen -v6.0.0 -#endregion - -#region docs/git/submodules.md Overrides - - docs/git/submodules.md -GoogleTest -superproject -#endregion - -#region docs/host-powershell/README.md Overrides - - docs/host-powershell/README.md -0-powershell -CorePsAssemblyLoadContext.cs -Kerberos-based -NTLM-based -post-6 -preview1-002106-00 -sample-dotnet1 -sample-dotnet2 -#endregion - -#region docs/learning-powershell/create-powershell-scripts.md Overrides - - docs/learning-powershell/create-powershell-scripts.md -NetIP.ps1. -RemoteSigned -#endregion - -#region docs/learning-powershell/debugging-from-commandline.md Overrides - - docs/learning-powershell/debugging-from-commandline.md -_Debuggers -about_Debuggers -celsius -Set-PSBreakpoint -test.ps1 -#endregion - -#region docs/learning-powershell/powershell-beginners-guide.md Overrides - - docs/learning-powershell/powershell-beginners-guide.md -dir -jen -LastWriteTime -#endregion - -#region docs/learning-powershell/README.md Overrides - - docs/learning-powershell/README.md -Lynda.com -Pluralsight -PowerShell.com -PowerShellMagazine.com -ScriptCenter -TechNet -#endregion - -#region docs/learning-powershell/using-vscode.md Overrides - - docs/learning-powershell/using-vscode.md -helloworld.ps1 -launch.json -OSs -#endregion - -#region docs/learning-powershell/working-with-powershell-objects.md Overrides - - docs/learning-powershell/working-with-powershell-objects.md -ForEach-Object -#endregion - -#region docs/maintainers/issue-management.md Overrides - - docs/maintainers/issue-management.md -Microsoft.PowerShell.Core -Microsoft.PowerShell.Management -Microsoft.PowerShell.Utility -omi -#endregion - -#region docs/maintainers/pull-request-process.md Overrides - - docs/maintainers/pull-request-process.md -ci-system -#endregion - -#region docs/maintainers/README.md Overrides - - docs/maintainers/README.md -andschwa -daxian-dbw -Dongbo -mirichmo -Schwartzmeyer -Sergei -TravisEz13 -Vorobev -vors -#endregion - -#region docs/maintainers/releasing.md Overrides - - docs/maintainers/releasing.md -2012r2 -CHANGELOG.md -Dockerfiles -downlevel -Effing -PowerShellCore -Ronn -Toolset -v6 -#endregion - -#region docs/testing-guidelines/PowerShellCoreTestStatus.md Overrides - - docs/testing-guidelines/PowerShellCoreTestStatus.md -Add-LocalGroupMember -add-on -adhoc -Clear-ItemProperty -Connect-PSSession -Connect-WSMan -ConvertFrom-Csv -ConvertFrom-SddlString -ConvertFrom-SecureString -ConvertFrom-StringData -ConvertTo-Csv -ConvertTo-Json -ConvertTo-SecureString -ConvertTo-Xml -Copy-ItemProperty -Debug-Runspace -Disable-LocalUser -Disable-PSBreakpoint -Disable-PSSessionConfiguration -Disable-PSTrace -Disable-PSWSManCombinedTrace -Disable-RunspaceDebug -Disable-WSManCredSSP -Disable-WSManTrace -Disconnect-PSSession -Disconnect-WSMan -Enable-LocalUser -Enable-PSBreakpoint -Enable-PSSessionConfiguration -Enable-PSTrace -Enable-PSWSManCombinedTrace -Enable-RunspaceDebug -Enable-WSManCredSSP -Enable-WSManTrace -Enter-PSHostProcess -Enter-PSSession -Exit-PSHostProcess -Exit-PSSession -Export-BinaryMiLog -Export-Clixml -Export-Csv -Export-FormatData -Export-ModuleMember -Find-DscResource -Find-PackageProvider -Find-RoleCapability -Get-CimAssociatedInstance -Get-CimClass -Get-CimInstance -Get-CimSession -Get-EventSubscriber -Get-ExecutionPolicy -Get-FileHash -Get-FormatData -Get-InstalledModule -Get-InstalledScript -Get-ItemProperty -Get-ItemPropertyValue -Get-LocalGroup -Get-LocalGroupMember -Get-LocalUser -Get-LogProperties -Get-PackageProvider -Get-PackageSource -Get-PSBreakpoint -Get-PSCallStack -Get-PSDrive -Get-PSHostProcessInfo -Get-PSProvider -Get-PSReadlineKeyHandler -Get-PSReadlineOption -Get-PSRepository -Get-PSSession -Get-PSSessionCapability -Get-Runspace -Get-RunspaceDebug -Get-TimeZone -Get-TypeData -Get-UICulture -Get-WSManCredSSP -Get-WSManInstance -Import-BinaryMiLog -Import-Clixml -Import-Csv -Import-LocalizedData -Import-PackageProvider -Import-PowerShellDataFile -Install-PackageProvider -Invoke-CimMethod -Invoke-WSManAction -Move-ItemProperty -New-CimInstance -New-CimSession -New-CimSessionOption -New-FileCatalog -New-Guid -New-ItemProperty -New-LocalGroup -New-LocalUser -New-ModuleManifest -New-PSDrive -New-PSSession -New-PSRoleCapabilityFile -New-PSSessionConfigurationFile -New-ScriptFileInfo -New-TemporaryFile -New-WinEvent -New-WSManInstance -New-WSManSessionOption -Receive-PSSession -Register-ArgumentCompleter -Register-CimIndicationEvent -Register-ObjectEvent -Register-PackageSource -Register-PSRepository -Remove-CimInstance -Remove-CimSession -Remove-ItemProperty -Remove-LocalGroup -Remove-LocalGroupMember -Remove-LocalUser -Remove-PSBreakpoint -Remove-PSDrive -Remove-PSReadlineKeyHandler -Remove-PSSession -Remove-TypeData -Remove-WSManInstance -Rename-ItemProperty -Rename-LocalGroup -Rename-LocalUser -Select-xml -Set-CimInstance -Set-ItemProperty -Set-LocalGroup -Set-LocalUser -Set-LogProperties -Set-PackageSource -Set-PSDebug -Set-PSReadlineKeyHandler -Set-PSReadlineOption -Set-PSRepository -Set-PSSessionConfiguration -Set-StrictMode -Set-TimeZone -Set-WSManInstance -Set-WSManQuickConfig -Test-FileCatalog -Test-ModuleManifest -Test-PSSessionConfigurationFile -Test-ScriptFileInfo -Test-WSMan -Unregister-PackageSource -Unregister-PSRepository -Update-FormatData -Update-ModuleManifest -Update-ScriptFileInfo -Update-TypeData -#endregion - -#region docs/testing-guidelines/testing-guidelines.md Overrides - - docs/testing-guidelines/testing-guidelines.md -100ms -Api -build.psm1 -DotNet -Interop -MessageAnalyzer -Microsoft.PowerShell.Core -Microsoft.PowerShell.Diagnostics -Microsoft.PowerShell.Management -Microsoft.PowerShell.Security -Microsoft.PowerShell.Utility -NativeExecution -TabCompletion -#endregion - -#region docs/testing-guidelines/TestRoadmap.md Overrides - docs/testing-guidelines/TestRoadmap.md _no_ -corefx -DotCover -Downlevel -KPIs -loopback -MVPs -OpenCover -org -PowerBI -Syslog -#endregion - -#region docs/testing-guidelines/WritingPesterTests.md Overrides - docs/testing-guidelines/WritingPesterTests.md -ErrorRecord -FQErrorId -FullyQualifiedErrorId -HelpersCommon.psm1 nGet-ContentOut-String nGet-MultiLineString PSDefaultParameterValues-skip ShouldShouldIt -StreamDescribeCIFeatureScenarioDescribeContextItContextContextBeforeAllAfterAllBeforeEachAfterEachshould -TestDrive -throw-testcasesItMockDescribe -#endregion - -#region README.md Overrides - - README.md -Gitter -microsoft.com -msi -omnisharp-vscode -o -opencode -pkg -tgz -UserVoice -Snapcraft -#endregion - -#region src/libpsl-native/README.md Overrides - - src/libpsl-native/README.md -Ansi -C#'s -codepage -libpsl-native -#endregion - -#region src/Microsoft.PowerShell.PSReadLine/en-US/PSReadline.md Overrides - - src/Microsoft.PowerShell.PSReadLine/en-US/PSReadline.md -_history.txt -_PSReadline -50ms -about_PSReadline -AddToHistoryHandler -AppData -BackgroundColor -BellStyle -BriefDescription -coloring -CompletionQueryItems -ConsoleColor -ConsoleKeyInfo -ContinuationPrompt -ContinuationPromptBackgroundColor -ContinuationPromptForegroundColor -DingDuration -DingTone -EditMode -EmphasisBackgroundColor -EmphasisForegroundColor -ErrorBackgroundColor -ErrorForegroundColor -ExtraPromptLineCount -ForegroundColor -ForwardWord -Func -HistoryNoDuplicates -HistorySavePath -HistorySaveStyle -HistorySearchBackward -HistorySearchCaseSensitive -HistorySearchCursorMovesToEnd -host.Name -Int32 -KillWord -MaximumHistoryCount -MaximumKillRingCount -Microsoft.PowerShell.KeyHandler -ResetTokenColors -ReverseSearchHistory -SaveAtExit -SaveIncrementally -SaveNothing -ScriptBlock -ShowToolTips -TokenClassification -TokenKind -ToString -ValidateAndAcceptLine -ValidationHandler -WordDelimiters -#endregion - -#region src/Microsoft.PowerShell.SDK/README.md Overrides - - src/Microsoft.PowerShell.SDK/README.md -metapackage -project.json -#endregion - -#region src/Modules/README.md Overrides - - src/Modules/README.md -ps1xml -psd1 -psm1 -#endregion - -#region src/powershell/README.md Overrides - - src/powershell/README.md -powershell-unix -#endregion - -#region src/TypeCatalogGen/README.md Overrides - - src/TypeCatalogGen/README.md -TypeCatalogGen -#endregion - -#region test/README.md Overrides - - test/README.md -csharp -fullclr -shebang -#endregion - -#region test/tools/CodeCoverageAutomation/README.md Overrides - - test/tools/CodeCoverageAutomation/README.md -CodeCoverage.zip -Coveralls.exe -Coveralls.io. -Coveralls.net -csmacnz -OpenCover.zip -powershell.version -Start-CodeCoverageRun -tests.zip -v5.0 -v6.0. -#endregion - -#region test/tools/WebListener/README.md Overrides - - test/tools/WebListener/README.md -Auth -failureCode -failureCount -NoResume -NTLM -NumberBytes -ResponseHeaders -sessionId -#endregion -includeide -interactivetesting -allowprerelease -prereleases -url - tools/performance/README.md -analyze -wpa -wpaProfile -PerfView -etl -perfview -wpr -wprui.exe -perfview.exe -GC.Regions.xml +Invoke-PerfviewPS JIT.Regions.xml PowerShell.Regions.xml PowerShell.stacktags PowerShell.wpaProfile PowerShell.wprp -Invoke-PerfviewPS +wpa +wpaProfile + - demos/WindowsPowerShellModules/README.md +2.x. diff --git a/.travis.yml b/.travis.yml index fc853e049d..cd1de5dd1b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -48,7 +48,7 @@ script: # spellcheck # Ignore 'Pester' folder because it's third party - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then - mdspell '**/*.md' '!**/Pester/**/*.md' --ignore-numbers --ignore-acronyms --report; + mdspell '**/*.md' '!**/Pester/**/*.md' --ignore-numbers --ignore-acronyms --report --en-us; fi after_failure: diff --git a/docs/learning-powershell/powershell-beginners-guide.md b/docs/learning-powershell/powershell-beginners-guide.md index 9194062848..8512e3f24a 100644 --- a/docs/learning-powershell/powershell-beginners-guide.md +++ b/docs/learning-powershell/powershell-beginners-guide.md @@ -1,18 +1,16 @@ -PowerShell Beginner’s Guide -==== +# PowerShell Beginner’s Guide If you are new to PowerShell, this document will walk you through a few examples to give you some basic ideas of PowerShell. We recommend that you open a PowerShell console/session and type along with the instructions in this document to get most out of this exercise. +## Launch PowerShell Console/Session -Launch PowerShell Console/Session ---- First you need to launch a PowerShell session by following the [Installing PowerShell Guide](./README.md#installing-powershell). +## Getting Familiar with PowerShell Commands -Getting Familiar with PowerShell Commands ---- In this section, you will learn how to + - create a file, delete a file and change file directory - discover what version of PowerShell you are currently using - exit a PowerShell session @@ -29,6 +27,7 @@ It is shown as **PS C:\\>** on Windows. **1. Get-Process**: Gets the processes that are running on the local computer or a remote computer. By default, you will get data back similar to the following: + ``` PowerShell PS /> Get-Process @@ -41,8 +40,10 @@ Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName … ``` + Only interested in the instance of firefox process that are running on your computer? Try this: + ```PowerShell PS /> Get-Process -Name firefox @@ -51,8 +52,10 @@ Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName - - - 74 403.150 1209 firefox ``` + Want to get back more than one process? Then just specify process names and separate them with commas. + ```PowerShell PS /> Get-Process -Name firefox, powershell Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName @@ -63,14 +66,17 @@ Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName ``` **2. Clear-Host**: Clears the display in the host program. + ```PowerShell PS /> Get-Process PS /> Clear-Host ``` + Type too much just for clearing the screen? Here is how the alias can help. **3. Get-Alias**: Gets the aliases for the current session. + ```PowerShell PS /> Get-Alias @@ -94,11 +100,14 @@ Now try it: PS /> Get-Process PS /> cls ``` + **4. cd - Set-Location**: Sets the current working location to a specified location. + ```PowerShell PS /> Set-Location /home PS /home> ``` + **5. dir - Get-ChildItem**: Gets the items and child items in one or more specified locations. ```PowerShell @@ -130,6 +139,7 @@ Mode LastWriteTime Length Name ---- ------------- ------ ---- -a---- 7/7/2016 7:17 PM 0 test.txt ``` + You can use the **-Value** parameter to add some data to your file. For example, the following command adds the phrase "Hello world!" as a file content to the test.txt. Because the test.txt file exists already, we use **-Force** parameter to replace the existing content. @@ -145,21 +155,25 @@ Mode LastWriteTime Length Name -a---- 7/7/2016 7:19 PM 24 test.txt ``` + There are other ways to add some data to a file. For example, you can use Set-Content to set the file contents: ```PowerShell PS /home/jen>Set-Content -Path ./test.txt -Value "Hello world again!" ``` + Or simply use ">" as below: -``` + +```powershell # create an empty file -"" > test.txt +"" > test.txt # set "Hello world!" as content of test.txt file "Hello world!!!" > test.txt ``` + The pound sign (#) above is used for comments in PowerShell. **7. type - Get-Content**: Gets the content of the item at the specified location. @@ -170,9 +184,11 @@ PS /home/jen> type -Path ./test.txt Hello world again! ``` + **8. del - Remove-Item**: Deletes the specified items. This cmdlet will delete the file /home/jen/test.txt: + ```PowerShell PS /home/jen> Remove-Item ./test.txt ``` @@ -190,7 +206,7 @@ PSEdition Core PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...} BuildVersion 3.0.0.0 GitCommitId v6.0.0-alpha.12 -CLRVersion +CLRVersion WSManStackVersion 3.0 PSRemotingProtocolVersion 2.3 SerializationVersion 1.1.0.1 @@ -198,56 +214,67 @@ SerializationVersion 1.1.0.1 ``` **10. Exit**: To exit the PowerShell session, type "exit". + ```PowerShell PS /home/jen> exit ``` -Need Help? ----- +## Need Help? + The most important command in PowerShell is possibly the Get-Help, which allows you to quickly learn PowerShell without having to search around the internet. The Get-Help cmdlet also shows you how PowerShell commands work with examples. It shows the syntax and other technical information of the Get-Process cmdlet. + ```PowerShell PS /> Get-Help -Name Get-Process ``` It displays the examples how to use the Get-Process cmdlet. + ```PowerShell PS />Get-Help -Name Get-Process -Examples ``` If you use **-Full** parameter, for example, `Get-Help -Name Get-Process -Full`, it will display more technical information. - -Discover Commands Available on Your System ----- +## Discover Commands Available on Your System You want to discover what PowerShell cmdlets available on your system? Just run "Get-Command" as below: + ```PowerShell PS /> Get-Command ``` + If you want to know whether a particular cmdlet exists on your system, you can do something like below: + ```PowerShell PS /> Get-Command Get-Process ``` + If you want to know the syntax of Get-Process cmdlet, type: + ```PowerShell PS /> Get-Command Get-Process -Syntax ``` + If you want to know how to use the Get-Process, type: + ```PowerShell PS /> Get-Help Get-Process -Example ``` -PowerShell Pipeline '|' ----- +## PowerShell Pipeline '|' + Sometimes when you run Get-ChildItem or "dir", you want to get a list of files and folders in a descending order. To achieve that, type: + ```PowerShell PS /home/jen> dir | Sort-Object -Descending ``` + Say you want to get the largest file in a directory + ```PowerShell PS /home/jen> dir | Sort-Object -Property Length -Descending | Select-Object -First 1 @@ -260,14 +287,14 @@ Mode LastWriteTime Length Name -a---- 5/16/2016 1:15 PM 32972 test.log ``` -How to Create and Run PowerShell scripts ----- + +## How to Create and Run PowerShell scripts + You can use Visual Studio Code or your favorite editor to create a PowerShell script and save it with a `.ps1` file extension. For more details, see [Create and Run PowerShell Script Guide][create-run-script] +## Recommended Training and Reading -Recommended Training and Reading ----- - Video: [Get Started with PowerShell][remoting] from Channel9 - [eBooks from PowerShell.org](https://powershell.org/ebooks/) - [eBooks from PowerShell.com][ebooks-powershell.com] @@ -284,9 +311,8 @@ Recommended Training and Reading - [Writing a PowerShell module in C#][writing-ps-module] - [Examples of Cmdlets Code][sample-code] +## Commercial Resources -Commercial Resources ----- - [Windows PowerShell in Action][in-action] by Bruce Payette - [Windows PowerShell Cookbook][cookbook] by Lee Holmes