mirror of
https://github.com/alibaba/arthas.git
synced 2024-04-21 10:21:39 +00:00
add grep command doc. #899
This commit is contained in:
@@ -14,7 +14,7 @@ import com.taobao.middleware.cli.annotations.Summary;
|
||||
* @see com.taobao.arthas.core.shell.command.internal.GrepHandler
|
||||
*/
|
||||
@Name("grep")
|
||||
@Summary("grep command for pipes.\n" )
|
||||
@Summary("grep command for pipes." )
|
||||
@Description(Constants.EXAMPLE +
|
||||
" sysprop | grep java \n" +
|
||||
" sysprop | grep java -n\n" +
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
|
||||
* help——查看命令帮助信息
|
||||
* [cat](cat.md)——打印文件内容,和linux里的cat命令类似
|
||||
* [grep]](grep.md)——匹配查找,和linux里的grep命令类似
|
||||
* [pwd](pwd.md)——返回当前的工作目录,和linux命令类似
|
||||
* cls——清空当前屏幕区域
|
||||
* session——查看当前会话的信息
|
||||
|
||||
@@ -30,6 +30,7 @@
|
||||
* [tt](tt.md)
|
||||
|
||||
* [cat](cat.md)
|
||||
* [grep](grep.md)
|
||||
* [pwd](pwd.md)
|
||||
* [options](options.md)
|
||||
|
||||
|
||||
@@ -6,6 +6,7 @@ Advanced Usage
|
||||
* help - display Arthas help
|
||||
* cls - clear the screen
|
||||
* [cat](cat.md) - Concatenate and print files
|
||||
* [grep]](grep.md) - Pattern searcher
|
||||
* [pwd](pwd.md) - Return working directory name
|
||||
* session - display current session information
|
||||
* [reset](reset.md) - reset all the enhanced classes. All enhanced classes will also be reset when Arthas server is closed by `shutdown`
|
||||
|
||||
@@ -30,6 +30,7 @@ All Commands
|
||||
* [tt](tt.md)
|
||||
|
||||
* [cat](cat.md)
|
||||
* [grep](grep.md)
|
||||
* [pwd](pwd.md)
|
||||
* [options](options.md)
|
||||
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
Grep
|
||||
===
|
||||
|
||||
> Similar to the traditional `grep` command.
|
||||
|
||||
|
||||
```
|
||||
USAGE:
|
||||
grep [-A <value>] [-B <value>] [-C <value>] [-h] [-i] [-v] [-n] [-m <value>] [-e] [--trim-end] pattern
|
||||
|
||||
SUMMARY:
|
||||
grep command for pipes.
|
||||
|
||||
EXAMPLES:
|
||||
sysprop | grep java
|
||||
sysprop | grep java -n
|
||||
sysenv | grep -v JAVA
|
||||
sysenv | grep -e "(?i)(JAVA|sun)" -m 3 -C 2
|
||||
sysenv | grep JAVA -A2 -B3
|
||||
thread | grep -m 10 -e "TIMED_WAITING|WAITING"
|
||||
|
||||
WIKI:
|
||||
https://alibaba.github.io/arthas/grep
|
||||
|
||||
OPTIONS:
|
||||
-A, --after-context <value> Print NUM lines of trailing context)
|
||||
-B, --before-context <value> Print NUM lines of leading context)
|
||||
-C, --context <value> Print NUM lines of output context)
|
||||
-h, --help this help
|
||||
-i, --ignore-case Perform case insensitive matching. By default, grep is case sensitive.
|
||||
-v, --invert-match Select non-matching lines
|
||||
-n, --line-number Print line number with output lines
|
||||
-m, --max-count <value> stop after NUM selected lines)
|
||||
-e, --regex Enable regular expression to match
|
||||
--trim-end Remove whitespaces at the end of the line
|
||||
<pattern> Pattern
|
||||
```
|
||||
@@ -0,0 +1,37 @@
|
||||
Grep
|
||||
===
|
||||
|
||||
> 类似传统的`grep`命令。
|
||||
|
||||
|
||||
```
|
||||
USAGE:
|
||||
grep [-A <value>] [-B <value>] [-C <value>] [-h] [-i] [-v] [-n] [-m <value>] [-e] [--trim-end] pattern
|
||||
|
||||
SUMMARY:
|
||||
grep command for pipes.
|
||||
|
||||
EXAMPLES:
|
||||
sysprop | grep java
|
||||
sysprop | grep java -n
|
||||
sysenv | grep -v JAVA
|
||||
sysenv | grep -e "(?i)(JAVA|sun)" -m 3 -C 2
|
||||
sysenv | grep JAVA -A2 -B3
|
||||
thread | grep -m 10 -e "TIMED_WAITING|WAITING"
|
||||
|
||||
WIKI:
|
||||
https://alibaba.github.io/arthas/grep
|
||||
|
||||
OPTIONS:
|
||||
-A, --after-context <value> Print NUM lines of trailing context)
|
||||
-B, --before-context <value> Print NUM lines of leading context)
|
||||
-C, --context <value> Print NUM lines of output context)
|
||||
-h, --help this help
|
||||
-i, --ignore-case Perform case insensitive matching. By default, grep is case sensitive.
|
||||
-v, --invert-match Select non-matching lines
|
||||
-n, --line-number Print line number with output lines
|
||||
-m, --max-count <value> stop after NUM selected lines)
|
||||
-e, --regex Enable regular expression to match
|
||||
--trim-end Remove whitespaces at the end of the line
|
||||
<pattern> Pattern
|
||||
```
|
||||
Reference in New Issue
Block a user