Start-Transcript 帮助信息

 

如下说明是翻译: help Start-Transcript 产生的帮助信息.

译者: Edengundam(马涛)

 

Start-Transcript

 

大纲

将全部或部分Windows PowerShell会话记录到文本文件中.

 

语法

Start-Transcript [[-path] <string>] [-force] [-noClobber] [-append] [-whatIf] [-confirm] [<CommonParameters>]

 

详细描述

Start-Transcript cmdlet将全部或部分Windows PowerShell会话记录到文本文件中. 此转录(transcript)包含了所有用户输入的命令和所有显示在控制台的输出信息.

 

参数

 

-path <string>

指定转录文件的位置. 输入一个指向.txt文件的路径(允许使用通配符).

 

如果没有指定路径, Start-Transcript将会使用全局变量$Transcript作为路径. 如果你没有创建此变量, Start-Transcript存储转录文件到$Home/My Documents目录, 文件名为/PowerShell_transcript.<时间戳>.txt格式.

 

如果路径中某个目录不存在, 此会导致命令执行失败.

 

强制参数?

false

参数位置?

1

默认值

variable

允许从管道绑定输入?

false

允许通配符扩展?

false

 

-force <SwitchParameter>

在不破坏安全前提下, 能够避免影响命令成功执行的限制条件. 例如, Force参数将会对只读属性的文件进行覆盖, 或者创建在文件名中不存在的目录, 但是它不会试图改变权限.

 

强制参数?

false

参数位置?

named

默认值

False

允许从管道绑定输入?

false

允许通配符扩展?

false

 

-noClobber <SwitchParameter>

不覆盖已经存在的文件(既替换原有内容).默认情况下, 如果在指定路径中已经有一个转录文件, Start-Transcript将直接覆盖文件而不会给出任何警告信息.

 

强制参数?

false

参数位置?

named

默认值

False

允许从管道绑定输入?

false

允许通配符扩展?

false

 

-append <SwitchParameter>

向一个存在的文件末尾添加新的转录信息. 使用参数Path指定文件.

 

强制参数?

false

参数位置?

named

默认值

Force

允许从管道绑定输入?

false

允许通配符扩展?

false

 

-whatIf

描述执行此命令将会发生的现象, 不会真正执行此命令.

 

强制参数?

false

参数位置?

named

默认值

 

允许从管道绑定输入?

false

允许通配符扩展?

false

 

-confirm

执行命令前提示你进行确认.

 

强制参数?

false

参数位置?

named

默认值

 

允许从管道绑定输入?

false

允许通配符扩展?

false

 

<公共参数>

此命令支持公共参数: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. 更多信息, 输入, "get-help about_commonparameters".

 

注意

 

更多信息, 输入"Get-Help Start-Transcript -detailed".需要技术信息, 输入"Get-Help Start-Transcript -full".

 

如果需要为该命令提供多个参数, 请使用逗号进行分隔. 例如, "<parameter-name> <value1>, <value2>".

 

停止转录功能, 使用Stop-Transcript cmdlet.

 

如果要记录完成会话信息, 将Start-Transcript命令添加到你个人的个性化文件(profile)中. 

例1

 

C:/PS>start-transcript

 

此命令开始转录功能, 并将输出保存到默认的文件位置.

 

例2

 

C:/PS>start-transcript -path c:/transcripts/transcript0.txt -noclobber

 

此命令开始转录功能(transcript), 并将信息存放到位于C:/transcripts目录的Transcript0.txt文件. 参数NoClobber阻止可能发生的覆盖情况. 如果Transcript0.txt文件已经存在, 此命令将会失败.

 

相关链接

Stop-Transcript