freebsd-skq/usr.bin/truss/truss.1

.\" $FreeBSD$
.\"
.Dd September 3, 2004
.Dt TRUSS 1
.Os
.Sh NAME
.Nm truss
.Nd trace system calls
.Sh SYNOPSIS
.Nm
.Op Fl faedDS
.Op Fl o Ar file
.Fl p Ar pid
.Nm
.Op Fl faedDS
.Op Fl o Ar file
command
.Op args
.Sh DESCRIPTION
The
.Nm
utility traces the system calls called by the specified process or program.
Output is to the specified output file, or standard error by default.
It does this by stopping and restarting the process being monitored via
.Xr procfs 5 .
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl f
Trace decendants of the original traced process created by
.Xr fork 2 ,
.Xr vfork 2 ,
etc.
.It Fl a
Show the argument strings that are passed in each
.Xr execve 2
system call.
.It Fl e
Show the environment strings that are passed in each
.Xr execve 2
system call.
.It Fl d
Include timestamps in the output showing the time elapsed
since the trace was started.
.It Fl D
Include timestamps in the output showing the time elapsed
since the last recorded event.
.It Fl S
Do not display information about signals received by the process.
(Normally,
.Nm
displays signal as well as system call events.)
.It Fl o Ar file
Print the output to the specified
.Ar file
instead of standard error.
.It Fl p Ar pid
Follow the process specified by
.Ar pid
instead of a new command.
.It Ar command Op args
Execute
.Ar command
and trace the system calls of it.
(The
.Fl p
and
.Ar command
options are mutually exclusive.)
.El
.Pp
The
.Xr procctl 8
utility can be used to clear tracepoints in a stuck process
left behind if truss abnormally terminates.
.Sh EXAMPLES
# Follow the system calls used in echoing "hello"
.Dl $ truss /bin/echo hello
# Do the same, but put the output into a file
.Dl $ truss -o /tmp/truss.out /bin/echo hello
# Follow an already-running process
.Dl $ truss -p 1
.Sh SEE ALSO
.Xr kdump 1 ,
.Xr ktrace 1 ,
.Xr procfs 5 ,
.Xr procctl 8
.Sh HISTORY
The
.Nm
command was written by
.An Sean Eric Fagan
for
.Fx .
It was modeled after
similar commands available for System V Release 4 and SunOS.
Add $FreeBSD$ lines to man pages that are missing them to make it easier for translation teams. PR: docs/13418 Submitted by: Alexey Zelkin <phantom@cris.net> 1999-08-28 23:23:38 +00:00			`.\" $FreeBSD$`
			`.\"`
Update doc dates. Pointed out by: ru 2004-09-03 18:56:59 +00:00			`.Dd September 3, 2004`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.Dt TRUSS 1`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 14:16:33 +00:00			`.Os`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.Sh NAME`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.Nm truss`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.Nd trace system calls`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Add options to print the argument and environment string parameters to execve(). This could be done in a more general manner but it still wouldn't be very pretty. MFC after: 3 weeks 2002-08-04 02:24:21 +00:00			`.Op Fl faedDS`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.Op Fl o Ar file`
			`.Fl p Ar pid`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
Add options to print the argument and environment string parameters to execve(). This could be done in a more general manner but it still wouldn't be very pretty. MFC after: 3 weeks 2002-08-04 02:24:21 +00:00			`.Op Fl faedDS`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.Op Fl o Ar file`
			`command`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.Op args`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm`
			`utility traces the system calls called by the specified process or program.`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`Output is to the specified output file, or standard error by default.`
			`It does this by stopping and restarting the process being monitored via`
			`.Xr procfs 5 .`
			`.Pp`
			`The options are as follows:`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.Bl -tag -width indent`
Allow tracking fork()ed children. PR: bin/25587 (in part) MFC after: 3 weeks 2002-08-04 01:02:52 +00:00			`.It Fl f`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 17:33:37 +00:00			`Trace decendants of the original traced process created by`
			`.Xr fork 2 ,`
			`.Xr vfork 2 ,`
			`etc.`
Add options to print the argument and environment string parameters to execve(). This could be done in a more general manner but it still wouldn't be very pretty. MFC after: 3 weeks 2002-08-04 02:24:21 +00:00			`.It Fl a`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 17:33:37 +00:00			`Show the argument strings that are passed in each`
			`.Xr execve 2`
			`system call.`
Add options to print the argument and environment string parameters to execve(). This could be done in a more general manner but it still wouldn't be very pretty. MFC after: 3 weeks 2002-08-04 02:24:21 +00:00			`.It Fl e`
mdoc(7) police: markup polishing. Approved by: re 2002-11-26 17:33:37 +00:00			`Show the environment strings that are passed in each`
			`.Xr execve 2`
			`system call.`
Add options to print absolute and relative timestamps. PR: bin/25587 (in part) MFC after: 3 weeks 2002-08-04 01:27:31 +00:00			`.It Fl d`
			`Include timestamps in the output showing the time elapsed`
			`since the trace was started.`
			`.It Fl D`
			`Include timestamps in the output showing the time elapsed`
			`since the last recorded event.`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.It Fl S`
			`Do not display information about signals received by the process.`
			`(Normally,`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.Nm`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`displays signal as well as system call events.)`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.It Fl o Ar file`
			`Print the output to the specified`
			`.Ar file`
			`instead of standard error.`
			`.It Fl p Ar pid`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`Follow the process specified by`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.Ar pid`
			`instead of a new command.`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.It Ar command Op args`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`Execute`
			`.Ar command`
			`and trace the system calls of it.`
			`(The`
			`.Fl p`
			`and`
			`.Ar command`
			`options are mutually exclusive.)`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`.El`
xref and give a hint as to what procctl can be used for. 2004-09-03 17:52:55 +00:00			`.Pp`
			`The`
			`.Xr procctl 8`
			`utility can be used to clear tracepoints in a stuck process`
			`left behind if truss abnormally terminates.`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.Sh EXAMPLES`
			`# Follow the system calls used in echoing "hello"`
			`.Dl $ truss /bin/echo hello`
			`# Do the same, but put the output into a file`
			`.Dl $ truss -o /tmp/truss.out /bin/echo hello`
			`# Follow an already-running process`
			`.Dl $ truss -p 1`
			`.Sh SEE ALSO`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.Xr kdump 1 ,`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.Xr ktrace 1 ,`
xref and give a hint as to what procctl can be used for. 2004-09-03 17:52:55 +00:00			`.Xr procfs 5 ,`
			`.Xr procctl 8`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`.Sh HISTORY`
			`The`
Sort Xrefs. Use err(3). Remove uneeded #include. Correct usage: one of {-p pid, command} is required. Open output file when command line is fully analyzed: incorrect `truss -o f' command does not create an empty file anymore. 1998-01-05 07:30:26 +00:00			`.Nm`
			`command was written by`
			`.An Sean Eric Fagan`
			`for`
Fxi various man pages to stop abusing the .Bx macro to generate the string "FreeBSD". Use the .Fx macro instead. Also did some minor re-wording/formatting to work around a deficiency with the .Fx macro when it comes to puncuation characters other than periods and commas. 2000-01-23 01:48:16 +00:00			`.Fx .`
			`It was modeled after`
Truss program. Requires procfs. 1997-12-06 05:23:12 +00:00			`similar commands available for System V Release 4 and SunOS.`