Rename folder Docs to docs

This commit is contained in:
Markus Fleschutz
2023-10-31 11:05:01 +01:00
parent 0915de8f8b
commit 893273739a
900 changed files with 304 additions and 304 deletions

75
docs/get-sha256.md Normal file
View File

@@ -0,0 +1,75 @@
*get-sha256.ps1*
================
This PowerShell script calculates and prints the SHA256 checksum of the given file.
Parameters
----------
```powershell
PS> ./get-sha256.ps1 [[-file] <String>] [<CommonParameters>]
-file <String>
Specifies the path to the file
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
Example
-------
```powershell
PS> ./get-sha256 C:\MyFile.txt
SHA256 hash is: CEB4AD71524996EB8AA3ADCE04F1E45636A4B58B8BF4462E6971CF2E56B4293E
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Prints the SHA256 checksum of a file
.DESCRIPTION
This PowerShell script calculates and prints the SHA256 checksum of the given file.
.PARAMETER file
Specifies the path to the file
.EXAMPLE
PS> ./get-sha256 C:\MyFile.txt
✔️ SHA256 hash is: CEB4AD71524996EB8AA3ADCE04F1E45636A4B58B8BF4462E6971CF2E56B4293E
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$file = "")
try {
if ($file -eq "" ) { $file = Read-Host "Enter the filename" }
$Result = get-filehash $file -algorithm SHA256
"✔️ SHA256 hash is: $($Result.Hash)"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of get-sha256.ps1 as of 10/19/2023 08:11:37)*