Skip to content

Latest commit

 

History

History
137 lines (94 loc) · 2.55 KB

Backup-WTSetting.md

File metadata and controls

137 lines (94 loc) · 2.55 KB
Raw
external help file Module Name online version schema
WTToolBox-help.xml
WTToolBox
2.0.0

Backup-WTSetting

SYNOPSIS

Backup Windows Terminal settings.json file.

SYNTAX

Backup-WTSetting [[-Limit] <Int32>] [-Destination] <String> [-Passthru] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Use this command to create a backup copy of the settings.json file for Windows Terminal. Each backup will be numbered up to the specified limit. The oldest file will be called settings.bak1.json, with the number incrementing for each backup.

EXAMPLES

Example 1

PS C:\> Backup-WTSetting -destination D:\OneDrive\Backups

Create backups to D:\OneDrive\Backups using the default limit.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Destination

Specify the backup location. It must exist.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Limit

The number of backup files to keep.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: 7
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Passthru

Write backup file objects to the pipeline. Otherwise the command doesn't write anything to the pipeline.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

None

System.IO.FileInfo

NOTES

This command has an alias of bwt.

Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

RELATED LINKS