From a204e215b766824aa84a697142b89a964db24b4d Mon Sep 17 00:00:00 2001 From: Aleksandar Nikolic Date: Sun, 17 Jul 2016 12:17:17 +0200 Subject: [PATCH] Fixed typos and code formatting Fixed typos in text and code and properly formatted code. --- .../powershell-beginners-guide.md | 94 +++++++++---------- 1 file changed, 46 insertions(+), 48 deletions(-) diff --git a/docs/learning-powerShell/powershell-beginners-guide.md b/docs/learning-powerShell/powershell-beginners-guide.md index fb179e6634..5c4de290d9 100644 --- a/docs/learning-powerShell/powershell-beginners-guide.md +++ b/docs/learning-powerShell/powershell-beginners-guide.md @@ -1,4 +1,4 @@ -PowerShell Beginners 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. @@ -20,17 +20,17 @@ In this section, you will learn how to - exit a PowerShell session - and more -As mentioned above, PowerShell commands is designed to have Verb-Noun structure, for instance Get-Process, Set-Location, Clear-Host, etc. +As mentioned above, PowerShell commands are designed to have Verb-Noun structure, for instance Get-Process, Set-Location, Clear-Host, etc. Let’s exercise some of the basic PowerShell commands, also known as **cmdlets**. Please note that we will use the PowerShell prompt sign **PS />** as it appears on Linux in the following examples. -It is shown as **PS C:\\>** on Windows. +It is shown as **PS C:\>** on Windows. **1. Get-Process**: displays the processes running on your system. By default, you will get data back similar to the following: ``` PowerShell -PS />Get-Process +PS /> Get-Process Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName ------- ------ ----- ----- ------ -- ----------- @@ -52,8 +52,7 @@ Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName ``` Want to get back more than one process? -Then just specify process names, separating with commas. -For example, +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,7 +62,7 @@ Handles NPM(K) PM(K) WS(K) CPU(s) Id ProcessName ``` -**2. Clear-Host**: Clears the display in the command window +**2. Clear-Host**: Clears the display in the host program. ```PowerShell PS /> Get-Process PS /> Clear-Host @@ -71,9 +70,7 @@ PS /> Clear-Host Type too much just for clearing the screen? Here is how the alias can help. -**3. Get-Alias**: Improves the user experience by using the Cmdlet aliases - -To find the available aliases, you can type below cmdlet: +**3. Get-Alias**: Gets the aliases for the current session. ```PowerShell PS /> Get-Alias @@ -97,12 +94,12 @@ Now try it: PS /> Get-Process PS /> cls ``` -**4. cd - Set-Location**: change your current working directory +**4. cd - Set-Location**: Change your current working directory. ```PowerShell PS /> Set-Location /home PS /home> ``` -**5. dir - Get-ChildItem**: list all items in the specified location +**5. dir - Get-ChildItem**: List all items in the specified location. ```PowerShell Get all files under the current directory: @@ -113,7 +110,7 @@ Get all files under the current directory as well as its subdirectories: PS /> cd $home PS /home/jen> dir -Recurse -List all files with file extension "txt". +List all files with "txt" file extension. PS /> cd $home PS /home/jen> dir –Path *.txt -Recurse @@ -134,11 +131,11 @@ Mode LastWriteTime Length Name -a---- 7/7/2016 7:17 PM 0 test.ps1 ``` You can use the **-Value** parameter to add some data to your file. -For example, the following command adds the phrase "Write-Host 'Hello There'" as a file content to the test.ps1. +For example, the following command adds the phrase "Write-Host 'Hello there!'" as a file content to the test.ps1. Because the test.ps1 file exists already, we use **-Force** parameter to replace the existing content. ```PowerShell -PS /home/jen> New-Item -Path ./test.ps1 -Value "Write-Host 'hello there'" -Force +PS /home/jen> New-Item -Path ./test.ps1 -Value "Write-Host 'Hello there!'" -Force Directory: /home/jen @@ -152,35 +149,35 @@ 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.ps1 -Value "Write-Host 'hello there again!'" +PS /home/jen>Set-Content -Path ./test.ps1 -Value "Write-Host 'Hello there again!'" ``` Or simply use ">" as below: ``` # create an empty file "" > empty.txt -# set "hello world!!!" as content of text.txt file +# set "hello world!!!" as content of empty.txt file "hello world!!!" > empty.txt ``` The pound sign (#) above is used for comments in PowerShell. -**7. type - Get-Content**: get the content of an item +**7. type - Get-Content**: Get the content of an item. ```PowerShell PS /home/jen> Get-Content -Path ./test.ps1 PS /home/jen> type -Path ./test.ps1 -"Write-Host 'hello there again!'" +Write-Host 'Hello there again!' ``` -**8. del - Remove-Item**: delete a file or folder +**8. del - Remove-Item**: Delete a file or folder. This cmdlet will delete the file /home/jen/test.ps1: ```PowerShell PS /home/jen> Remove-Item ./test.ps1 ``` -**9. $PSVersionTable**: displays the version of PowerShell you are currently using +**9. $PSVersionTable**: Displays the version of PowerShell you are currently using. Type **$PSVersionTable** in your PowerShell session, you will see something like below. "PSVersion" indicates the PowerShell version that you are using. @@ -199,51 +196,52 @@ SerializationVersion 1.1.0.1 ``` -**10. Exit**: to exit the PowerShell session, type "exit" +**10. Exit**: To exit the PowerShell session, type "exit". ```PowerShell PS /home/jen> exit ``` Need Help? ---- -The most important command in PowerShell is possibly the Get-Help, which allows you to quickly learn PowerShell without having to surf around the Internet. +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. -PS />**Get-Help -Name Get-Process** - It shows the syntax and other technical information of the Get-Process cmdlet. - - -PS />**Get-Help -Name Get-Process -Examples** +```PowerShell +PS /> Get-Help -Name Get-Process +``` It displays the examples how to use the Get-Process cmdlet. -If you use **-Full** parameter, i.e., "Get-Help -Name Get-Process -Full", it will display more technical information. +```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 All Commands Available on Your System +Discover Commands Available on Your System ---- -You want to discover what PowerShell cmdlets available on your system? Simple, just run "Get-Command" as below. - -PS /> **Get-Command** - +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: - -PS /> **Get-Command Get-Process** - -If you want to know the syntax of Get-Process cmdlet, type - -PS /> **Get-Command Get-Process -Syntax** - -If you want to know how to use the Get-Process, type - -PS /> **Get-Help Get-Process -Example** - +```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 '|' ---- -Sometimes when you run Get-ChildItem or "dir", you want to get a list of files in a descending order. +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 -Descending @@ -266,7 +264,7 @@ How to Create and Run PowerShell scripts - You can use ISE, VS Code or your favorite editor to create a PowerShell script and save the script with a .ps1 file extension (for example, helloworld.ps1) - To run the script, cd to your current folder and type ./yourscript.ps1 (for example, ./helloworld.ps1). -Note: if you are using Windows, make sure you set the PowerShell's execution policy to "RemoteSigned" in this case. +Note: If you are using Windows, make sure you set the PowerShell's execution policy to "RemoteSigned" in this case. See [Running PowerShell Scripts Is as Easy as 1-2-3] [run-ps] for more details. [run-ps]:http://windowsitpro.com/powershell/running-powershell-scripts-easy-1-2-3