mirrors/PowerShell
0
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell.git synced 2024-11-23 09:43:57 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix crontab formatting in example doc (#13712)

Browse Source 
* Updating formatting

Fixing formatting

* Update CronTab.psm1
This commit is contained in:
Dave Goldman 2020-10-02 07:54:15 -04:00 committed by GitHub
parent e107ecd08d
commit b7cabd4063
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
demos/crontab/CronTab/CronTab.psm1
View File

@ -77,16 +77,22 @@ function Remove-CronJob {
<#
.SYNOPSIS
Removes the exactly matching cron job from the cron table
.DESCRIPTION
Removes the exactly matching cron job from the cron table
.EXAMPLE
Get-CronJob | Where-Object {%_.Command -like 'foo *'} | Remove-CronJob
.RETURNVALUE
None
.PARAMETER UserName
Optional parameter to specify a specific user's cron table
.PARAMETER Job
Cron job object returned from Get-CronJob
.PARAMETER Force
Don't prompt when removing the cron job
#>
@ -143,20 +149,28 @@ function New-CronJob {
0-23/2 or */2.
.EXAMPLE
New-CronJob -Minute 10-30 -Hour 10-20/2 -DayOfMonth */2 -Command "/bin/bash -c 'echo hello' > ~/hello"
.RETURNVALUE
If successful, an object representing the cron job is returned
.PARAMETER UserName
Optional parameter to specify a specific user's cron table
.PARAMETER Minute
Valid values are 0 to 59. If not specified, defaults to *.
.PARAMETER Hour
Valid values are 0-23. If not specified, defaults to *.
.PARAMETER DayOfMonth
Valid values are 1-31. If not specified, defaults to *.
.PARAMETER Month
Valid values are 1-12. If not specified, defaults to *.
.PARAMETER DayOfWeek
Valid values are 0-7. 0 and 7 are both Sunday. If not specified, defaults to *.
.PARAMETER Command
Command to execute at the scheduled time and day.
#>
@ -190,12 +204,16 @@ function Get-CronJob {
<#
.SYNOPSIS
Returns the current cron jobs from the cron table
.DESCRIPTION
Returns the current cron jobs from the cron table
.EXAMPLE
Get-CronJob -UserName Steve
.RETURNVALUE
CronJob objects
.PARAMETER UserName
Optional parameter to specify a specific user's cron table
#>