如何在执行时回显 shell 命令

Question

在 shell 脚本中，如何回显所有调用的 shell 命令并扩展任何变量名称？

例如，给定以下行：

ls $DIRNAME

我希望脚本运行命令并显示以下内容

ls /full/path/to/some/dir

目的是保存所有调用的 shell 命令及其参数的日志。 也许有更好的方法来生成这样的日志？

Answer 1

set -x或set -o xtrace扩展变量并在行前打印一个小 + 号。

set -v或set -o verbose不会在打印前扩展变量。

使用set +x和set +v关闭上述设置。

在脚本的第一行，可以将#!/bin/sh -x (或-v ) 放在脚本后面的set -x (或-v ) 具有相同的效果。

以上也适用于/bin/sh 。

请参阅有关set属性和调试的 bash-hackers wiki。

$ cat shl
#!/bin/bash                                                                     

DIR=/tmp/so
ls $DIR

$ bash -x shl 
+ DIR=/tmp/so
+ ls /tmp/so
$

Answer 2

set -x会给你你想要的。

下面是一个示例 shell 脚本来演示：

#!/bin/bash
set -x #echo on

ls $PWD

这将扩展所有变量并在命令输出之前打印完整命令。

输出：

+ ls /home/user/
file1.txt file2.txt

Answer 3

我使用一个函数来回显并运行命令：

#!/bin/bash
# Function to display commands
exe() { echo "\$ $@" ; "$@" ; }

exe echo hello world

哪些输出

$ echo hello world
hello world

对于更复杂的命令管道等，可以使用 eval：

#!/bin/bash
# Function to display commands
exe() { echo "\$ ${@/eval/}" ; "$@" ; }

exe eval "echo 'Hello, World!' | cut -d ' ' -f1"

哪些输出

$  echo 'Hello, World!' | cut -d ' ' -f1
Hello

Answer 4

您还可以通过将它们包装在set -x和set +x中来为脚本中的选择行切换它，例如，

#!/bin/bash
...
if [[ ! -e $OUT_FILE ]];
then
   echo "grabbing $URL"
   set -x
   curl --fail --noproxy $SERV -s -S $URL -o $OUT_FILE
   set +x
fi

Answer 5

shuckc对回显选择行的回答有一些缺点：您最终也回显了以下set +x命令，并且您无法使用$? 因为它被set +x覆盖。

另一种选择是在子shell中运行命令：

echo "getting URL..."
( set -x ; curl -s --fail $URL -o $OUTFILE )

if [ $? -eq 0 ] ; then
    echo "curl failed"
    exit 1
fi

这将为您提供如下输出：

getting URL...
+ curl -s --fail http://example.com/missing -o /tmp/example
curl failed

不过，这确实会产生为命令创建新子 shell 的开销。

Answer 6

另一种选择是将“-x”放在脚本的顶部而不是命令行上：

$ cat ./server
#!/bin/bash -x
ssh user@server

$ ./server
+ ssh user@server
user@server's password: ^C
$

Answer 7

根据TLDP的Bash 初学者指南：第 2 章编写和调试脚本：

2.3.1. 调试整个脚本

$ bash -x script1.sh

...

现在有一个成熟的 Bash 调试器，可在SourceForge 获得。 这些调试功能在大多数现代版本的 Bash 中都可用，从 3.x 开始。

2.3.2. 调试脚本的一部分

set -x # Activate debugging from here w set +x # Stop debugging from here

...

表 2-1。 设置调试选项概述

    Short  | Long notation | Result
    -------+---------------+--------------------------------------------------------------
    set -f | set -o noglob | Disable file name generation using metacharacters (globbing).
    set -v | set -o verbose| Prints shell input lines as they are read.
    set -x | set -o xtrace | Print command traces before executing command.

...

或者，可以在脚本本身中指定这些模式，方法是将所需的选项添加到第一行 shell 声明中。 可以组合选项，就像 UNIX 命令的情况一样：

 #!/bin/bash -xv

Answer 8

在命令行上的 Bash 脚本名称之前键入“bash -x”。 例如，要执行 foo.sh，请键入：

bash -x foo.sh

Answer 9

您可以使用-x选项在调试模式下执行Bash 脚本。

这将回显所有命令。

bash -x example_script.sh

# Console output
+ cd /home/user
+ mv text.txt mytext.txt

您还可以在脚本中保存 -x 选项。 只需在 shebang 中指定-x选项即可。

######## example_script.sh ###################
#!/bin/bash -x

cd /home/user
mv text.txt mytext.txt

##############################################

./example_script.sh

# Console output
+ cd /home/user
+ mv text.txt mytext.txt

Answer 10

对于 zsh，回显

setopt VERBOSE

为了调试，

setopt XTRACE

Answer 11

上面发布的人：

#!/bin/bash
#function to display commands
exe() { echo "\$ $@" ; "$@" ; }

这看起来很有希望，但我不能为我的生活弄清楚它的作用。 我在Google bash页面搜索并搜索了“\\ $”和“$ @”，并且一无所获 。

我知道正在创建一个名为“exec（）”的函数。 我理解花括号标记了函数的开头和结尾。 我想我明白，分号标志着多行命令之间的“硬回程”，所以'{echo“\\ $ $ @”; “$ @”; 从本质上说：

{
echo "\$ $@"
"$@"

}

任何人都可以给我一个简短的解释，或者在哪里可以找到这些信息，因为很明显我的google-fu失败了吗？

（没有意义在旧线程上开始一个新问题，我的目标是将输出重新路由到文件。“set -x; [commands]; set + x”方法对我来说效果很好，但我可以' t弄清楚如何将结果回显到文件而不是屏幕，所以我试图理解这个其他方法，希望我可以使用非常糟糕的理解重定向/管道/ tee /等来做同样的事情。）

谢谢！

后期编辑：

经过一些修补，我相信我弄明白了。 这是我需要的等效代码：

SCRIPT_LOG="\home\buddy\logfile.txt"
exe () {
  params="$@"                       # Put all of the command-line into "params"
  printf "%s\t$params" "$(date)" >> "$SCRIPT_LOG"   # Print the command to the log file
  $params                           # Execute the command
}

exe rm -rf /Library/LaunchAgents/offendingfile
exe rm -rf /Library/LaunchAgents/secondoffendingfile

logfile.txt中的结果如下所示：

Tue Jun  7 16:59:57 CDT 2016  rm -rf /Library/LaunchAgents/offendingfile
Tue Jun  7 16:59:57 CDT 2016  rm -rf /Library/LaunchAgents/secondoffendingfile

正是我需要的。 谢谢！

Answer 12

结合所有答案，我发现这是最好的，最简单的

# https://stackoverflow.com/a/64644990/8608146
exe(){
    set -x
    "$@"
    { set +x; } 2>/dev/null
}
# example
exe go generate ./...

{ set +x; } 2>/dev/null { set +x; } 2>/dev/null来自https://stackoverflow.com/a/19226038/8608146

如果需要命令的退出状态，如这里所述

用

{ STATUS=$?; set +x; } 2>/dev/null

并稍后使用$STATUS就像最后exit $STATUS

一个稍微有用的

# https://stackoverflow.com/a/64644990/8608146
_exe(){
    [ $1 == on  ] && { set -x; return; } 2>/dev/null
    [ $1 == off ] && { set +x; return; } 2>/dev/null
    echo + "$@"
    "$@"
}
exe(){
    { _exe "$@"; } 2>/dev/null
}

# examples
exe on # turn on same as set -x
echo This command prints with +
echo This too prints with +
exe off # same as set +x
echo This does not

# can also be used for individual commands
exe echo what up!

Answer 13

对于csh和tcsh ，您可以set verbose或set echo （或者您甚至可以同时设置两者，但在大多数情况下可能会导致一些重复）。

verbose选项几乎打印出您键入的确切 shell 表达式。

echo选项更能说明将通过生成执行的内容。

---

http://www.tcsh.org/tcsh.html/Special_shell_variables.html#verbose

http://www.tcsh.org/tcsh.html/Special_shell_variables.html#echo

---

Special shell variables

verbose If set, causes the words of each command to be printed, after history substitution (if any). Set by the -v command line option.

echo If set, each command with its arguments is echoed just before it is executed. For non-builtin commands all expansions occur before echoing. Builtin commands are echoed before command and filename substitution, because these substitutions are then done selectively. Set by the -x command line option.

Answer 14

为了允许回显复合命令，我使用eval加上 Soth 的exe函数来回显和运行命令。 这对于管道命令非常有用，否则这些命令将只显示不显示或仅显示管道命令的初始部分。

没有评估：

exe() { echo "\$ $@" ; "$@" ; }
exe ls -F | grep *.txt

输出：

$
file.txt

与评估：

exe() { echo "\$ $@" ; "$@" ; }
exe eval 'ls -F | grep *.txt'

哪些输出

$ exe eval 'ls -F | grep *.txt'
file.txt

Answer 15

$ cat exampleScript.sh
#!/bin/bash
name="karthik";
echo $name;

bash -x exampleScript.sh

输出如下：