.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FBTRACEMGR 1"
.TH FBTRACEMGR 1 2024-03-05 "Firebird 3.0" "Firebird documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
fbtracemgr \- Firebird operation traces
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBfbtracemgr\fR \fIaction\fR [\fIparameter\fR...]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBfbtracemgr\fR gives access to the trace API of Firebird. It connects to a
Firebird server, starts a trace session and prints the audit trail to standard
output.
.PP
To cancel the trace session, press \f(CW\*(C`Ctrl+C\*(C'\fR, send the \f(CW\*(C`TERM\*(C'\fR signal or use
the stop command.
.SH OPTIONS
.IX Header "OPTIONS"
.SS Actions
.IX Subsection "Actions"
.IP \fB\-sta\fR 4
.IX Item "-sta"
.PD 0
.IP \fB\-start\fR 4
.IX Item "-start"
.PD
Start a trace session
.IP \fB\-sto\fR 4
.IX Item "-sto"
.PD 0
.IP \fB\-stop\fR 4
.IX Item "-stop"
.PD
Stop a trace session
.IP \fB\-su\fR 4
.IX Item "-su"
.PD 0
.IP \fB\-suspend\fR 4
.IX Item "-suspend"
.PD
Suspend a trace session. No output is produced until the session is resumed.
.IP \fB\-r\fR 4
.IX Item "-r"
.PD 0
.IP \fB\-resume\fR 4
.IX Item "-resume"
.PD
Resume a suspended trace session.
.IP \fB\-l\fR 4
.IX Item "-l"
.PD 0
.IP \fB\-list\fR 4
.IX Item "-list"
.PD
List existing trace sessions
.SS "Action parameters"
.IX Subsection "Action parameters"
.IP "\fB\-n\fR \fIstring\fR" 4
.IX Item "-n string"
.PD 0
.IP "\fB\-name\fR \fIstring\fR" 4
.IX Item "-name string"
.PD
Session name
.IP "\fB\-i\fR \fInumber\fR" 4
.IX Item "-i number"
.PD 0
.IP "\fB\-id\fR \fInumber\fR" 4
.IX Item "-id number"
.PD
Session ID
.IP "\fB\-c\fR \fIpath\fR" 4
.IX Item "-c path"
.PD 0
.IP "\fB\-config\fR \fIpath\fR" 4
.IX Item "-config path"
.PD
Path to the trace configuration file
.SS "Connection parameters"
.IX Subsection "Connection parameters"
.IP \fB\-se\fR 4
.IX Item "-se"
.PD 0
.IP "\fB\-service\fR \fIstring\fR" 4
.IX Item "-service string"
.PD
Service name in the form of \f(CW\*(C`service_mgr\*(C'\fR (for local connection) or
\&\fIhost\fR:\f(CW\*(C`service_mgr\*(C'\fR (for remote connection).
.IP "\fB\-u\fR \fIuser\fR" 4
.IX Item "-u user"
.PD 0
.IP "\fB\-user\fR \fIuser\fR" 4
.IX Item "-user user"
.PD
User name to connect as.
.IP "\fB\-p\fR \fIpassword\fR" 4
.IX Item "-p password"
.PD 0
.IP "\fB\-password\fR \fIpassword\fR" 4
.IX Item "-password password"
.PD
Connection password.
.IP "\fB\-fe\fR \fIfile\fR" 4
.IX Item "-fe file"
.PD 0
.IP "\fB\-fetch\fR \fIfile\fR" 4
.IX Item "-fetch file"
.PD
Read password from file.
.IP "\fB\-t\fR \fIstring\fR" 4
.IX Item "-t string"
.PD 0
.IP "\fB\-trusted\fR \fIstring\fR" 4
.IX Item "-trusted string"
.PD
Force trusted authentication
.SH EXAMPLES
.IX Header "EXAMPLES"
.Vb 5
\&  fbtracemgr \-se remote_host:service_mgr \-user sysdba \-pass masterkey \-list
\&  fbtracemgr \-se service_mgr \-start \-name my_trace \-config my_cfg.txt
\&  fbtracemgr \-se service_mgr \-suspend \-id 2
\&  fbtracemgr \-se service_mgr \-resume \-id 2
\&  fbtracemgr \-se service_mgr \-stop \-id 4
.Ve
.SH "AUTHOR & COPYRIGHT"
.IX Header "AUTHOR & COPYRIGHT"
Copyright (C) Damyan Ivanov, 2009.
.PP
This manpage was written by Damyan Ivanov for the Debian project but may be
used by others. Permission is granted to use this document, with or without
modifications, provided that this notice is retained. If we meet some day, and
you think this stuff is worth it, you can buy me a beer in return.