Skip to content

Commit

Permalink
regenerate the man page
Browse files Browse the repository at this point in the history
  • Loading branch information
ldegio committed Aug 26, 2015
1 parent 9744516 commit a579a8a
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 3 deletions.
41 changes: 40 additions & 1 deletion userspace/sysdig/man/csysdig.8
Expand Up @@ -16,19 +16,37 @@ csysdig has been designed to mimic tools like \f[B]top\f[] and
.IP \[bu] 2
Support for both live analysis and sysdig trace files.
Trace files can come from the same machine or from another machine.
.PD 0
.P
.PD
.IP \[bu] 2
Visibility into a broad range of metrics, including CPU, memory, disk
I/O, network I/O.
.PD 0
.P
.PD
.IP \[bu] 2
Ability to observe input/output activity for processes, files, network
connections and more.
.PD 0
.P
.PD
.IP \[bu] 2
Ability to drill down into processes, files, network connections and
more to further explore their behavior.
.PD 0
.P
.PD
.IP \[bu] 2
Full customization support.
.PD 0
.P
.PD
.IP \[bu] 2
Support for sysdig\[aq]s filtering language.
.PD 0
.P
.PD
.IP \[bu] 2
Container support by design.
.PP
Expand All @@ -53,14 +71,26 @@ Here are some basic tips to get you started with sysdig:
If you run csysdig without arguments, it will display live system data,
updating every 2 seconds.
To analyze a trace file, use the \-r command line flag.
.PD 0
.P
.PD
.IP "2." 3
You can switch to a different view by using the \f[I]F2\f[] key.
.PD 0
.P
.PD
.IP "3." 3
You can to drill down into a selection by clicking \f[I]enter\f[].
You can navigate back by typing \f[I]backspace\f[].
.PD 0
.P
.PD
.IP "4." 3
You can observe input/output for the currently selected entity by typing
\f[I]F5\f[]
.PD 0
.P
.PD
.IP "5." 3
You can see sysdig events for the currently selected entity by typing
\f[I]F6\f[]
Expand Down Expand Up @@ -231,12 +261,21 @@ Go to line.
.SS MOUSE USAGE
.IP \[bu] 2
Clicking on column headers lets you sort the table.
.PD 0
.P
.PD
.IP \[bu] 2
Double clicking on row entries performs a drill down.
.PD 0
.P
.PD
.IP \[bu] 2
Clicking on the filter string at the top of the screen (the text after
\[aq]Filter:\[aq]) lets you change the sysdig filter and customize the
view content.
.PD 0
.P
.PD
.IP \[bu] 2
You can use the mouse on the entries in the menu at the bottom of the
screen to perform their respective actions.
Expand Down Expand Up @@ -307,7 +346,7 @@ Capture the first \f[I]len\f[] bytes of each I/O buffer.
By default, the first 80 bytes are captured.
Use this option with caution, it can generate huge trace files.
.PP
\f[B]\-v\f[] \f[I]view_id\f[], \f[B]\-\-views\f[]=\f[I]view_id\f[]
\f[B]\-v\f[] \f[I]view\f[]id_, \f[B]\-\-views\f[]=\f[I]view\f[]id_
.PD 0
.P
.PD
Expand Down
27 changes: 25 additions & 2 deletions userspace/sysdig/man/sysdig.8
Expand Up @@ -28,25 +28,46 @@ and can be extended through Lua scripts, called chisels.
By default, sysdig prints the information for each captured event on a
single line, with the following format:
.PP
\f[C]<evt.num>\ <evt.time>\ <evt.cpu>\ <proc.name>\ <thread.tid>\ <evt.dir>\ <evt.type>\ <evt.args>\f[]
\f[C]*%evt.num\ %evt.time\ %evt.cpu\ %proc.name\ (%thread.tid)\ %evt.dir\ %evt.type\ %evt.info\f[]
.PP
where:
.IP \[bu] 2
evt.num is the incremental event number
.PD 0
.P
.PD
.IP \[bu] 2
evt.time is the event timestamp
.PD 0
.P
.PD
.IP \[bu] 2
evt.cpu is the CPU number where the event was captured
.PD 0
.P
.PD
.IP \[bu] 2
proc.name is the name of the process that generated the event
.PD 0
.P
.PD
.IP \[bu] 2
thread.tid id the TID that generated the event, which corresponds to the
PID for single thread processes
.PD 0
.P
.PD
.IP \[bu] 2
evt.dir is the event direction, > for enter events and < for exit events
.PD 0
.P
.PD
.IP \[bu] 2
evt.type is the name of the event, e.g.
\[aq]open\[aq] or \[aq]read\[aq]
.PD 0
.P
.PD
.IP \[bu] 2
evt.args is the list of event arguments.
.PP
Expand All @@ -56,7 +77,7 @@ the fields listed by \[aq]sysdig \-l\[aq].
Using \-pc or \-pcontainer, the default format will be changed to a
container\-friendly one:
.PP
\f[C]%evt.num\ %evt.time\ %evt.cpu\ %container.name\ (%container.id)\ %proc.name\ (%thread.tid:%thread.vtid)\ %evt.dir\ %evt.type\ %evt.info\f[]
\f[C]*%evt.num\ %evt.time\ %evt.cpu\ %container.name\ (%container.id)\ %proc.name\ (%thread.tid:%thread.vtid)\ %evt.dir\ %evt.type\ %evt.info\f[]
.PP
\f[B]Trace Files\f[]
.PP
Expand Down Expand Up @@ -341,6 +362,8 @@ Print progress on stderr while processing trace files.
Specify the format to be used when printing the events.
With \-pc or \-pcontainer will use a container\-friendly format.
See the examples section below for more info.
Specifying \f[B]\-pp\f[] on the command line will cause sysdig to print
the default command line format and exit.
.PP
\f[B]\-q\f[], \f[B]\-\-quiet\f[]
.PD 0
Expand Down

0 comments on commit a579a8a

Please sign in to comment.