.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "TRAFFIC_SERVER" "8" "Jan 06, 2024" "9.2" "Apache Traffic Server"
.SH NAME
traffic_server \- Traffic Server
.SH DESCRIPTION
.SH OPTIONS
.INDENT 0.0
.TP
.B \-a, \-\-accepts_thread
.UNINDENT
.INDENT 0.0
.TP
.B \-b, \-\-accept_till_done
.UNINDENT
.INDENT 0.0
.TP
.B \-B TAGS, \-\-action_tags TAGS
.UNINDENT
.INDENT 0.0
.TP
.B \-\-bind_stdout FILE
.UNINDENT
.sp
The file to which the stdout stream for Traffic Server will be bound.
.INDENT 0.0
.TP
.B \-\-bind_stderr FILE
.UNINDENT
.sp
The file to which the stderr stream for Traffic Server will be bound.
.INDENT 0.0
.TP
.B \-C \(aqCMD [ARGS]\(aq, \-\-command \(aqCMD [ARGS]\(aq
.UNINDENT
.sp
Run a Traffic Server maintenance command. These commands perform various administrative
actions or queries against Traffic Server\&. Note that some commands (such as \fBhelp\fP and
\fBverify_global_plugin\fP) take an argument. To invoke the command and its
argument, surround the \fBCMD\fP and its argument in quotes. For instance, to
request help for the \fBverify_global_plugin\fP command, format your command like
so:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
traffic_server \-C \(dqhelp verify_global_plugin\(dq
.EE
.UNINDENT
.UNINDENT
.sp
The following commands are supported:
.INDENT 0.0
.TP
.B list
List the sizes of the host database and cache index as well as the storage
available to the cache.
.TP
.B check
Check the cache for inconsistencies or corruption. \fBcheck\fP does not make
any changes to the data stored in the cache. \fBcheck\fP requires a scan of
the contents of the cache and may take a long time for large caches.
.TP
.B clear
Clear the entire cache, both the document and the host database caches.  All
data in the cache is lost and the cache is reconfigured based on the current
description of database sizes and available storage.
.TP
.B clear_cache
Clear the document cache.  All documents in the cache are lost and the cache
is reconfigured based on the current description of database sizes and
available storage.
.TP
.B clear_hostdb
Clear the entire host database cache.  All host name resolution information
is lost.
.TP
.B verify_config
Load the config and verify Traffic Server comes up correctly.
.TP
.B verify_global_plugin PLUGIN_SO_FILE
Load a global plugin\(aqs shared object file and verify it meets minimal global
plugin API requirements.
.TP
.B verify_remap_plugin PLUGIN_SO_FILE
Load a remap plugin\(aqs shared object file and verify it meets minimal remap
plugin API requirements.
.TP
.B help [CMD]
Obtain a short description of a command. For example, \fB\(aqhelp clear\(aq\fP
prints a description of the \fBclear\fP maintenance command. If no argument
is passed to \fBhelp\fP then a list of the supported maintenance commands are
printed along with a brief description of each.
.UNINDENT
.INDENT 0.0
.TP
.B \-f, \-\-disable_freelist
.UNINDENT
.sp
In order to improve performance, \fBtraffic_server\fP caches commonly used data structures in a
set of free object lists. This option disables these caches, causing \fBtraffic_server\fP to
use \fBmalloc(3)\fP for every allocation. Though this option should not commonly be needed, it
may be beneficial in memory\-constrained environments or where the working set is highly variable.
.INDENT 0.0
.TP
.B \-F, \-\-disable_pfreelist
.UNINDENT
.sp
Disable free list in ProxyAllocator which were left out by the \-f option. This option includes the
functionality of \fI\%\-f\fP\&.
.INDENT 0.0
.TP
.B \-R LEVEL, \-\-regression LEVEL
.UNINDENT
.INDENT 0.0
.TP
.B \-r TEST, \-\-regression_test TEST
.UNINDENT
.INDENT 0.0
.TP
.B \-l, \-\-regression_list
.UNINDENT
.sp
If Traffic Server was built with tests enabled, this option lists
the available tests.
.INDENT 0.0
.TP
.B \-T TAGS, \-\-debug_tags TAGS
.UNINDENT
.INDENT 0.0
.TP
.B \-i COUNT, \-\-interval COUNT
.UNINDENT
.INDENT 0.0
.TP
.B \-m COUNT, \-\-maxRecords
.UNINDENT
.sp
The maximum number of entries in metrics and configuration variables. The default is 1600, which is
also the minimum. This may need to be increased if running plugins that create metrics.
.INDENT 0.0
.TP
.B \-M, \-\-remote_management
.UNINDENT
.sp
Indicates the process should expect to be managed by \fI\%traffic_manager\fP\&. This option should not
be used except by that process.
.INDENT 0.0
.TP
.B \-n COUNT, \-\-net_threads COUNT
.UNINDENT
.INDENT 0.0
.TP
.B \-k, \-\-clear_hostdb
.UNINDENT
.INDENT 0.0
.TP
.B \-K, \-\-clear_cache
.UNINDENT
.INDENT 0.0
.TP
.B \-\-accept_mss MSS
.UNINDENT
.INDENT 0.0
.TP
.B \-t MSECS, \-\-poll_timeout MSECS
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-\-help
Print usage information and exit.
.UNINDENT
.INDENT 0.0
.TP
.B \-p PORT, \-\-httpport PORT
.UNINDENT
.INDENT 0.0
.TP
.B \-U COUNT, \-\-udp_threads COUNT
.UNINDENT
.INDENT 0.0
.TP
.B \-V, \-\-version
Print version information and exit.
.UNINDENT
.SH ENVIRONMENT
.INDENT 0.0
.TP
.B PROXY_REMOTE_MGMT
.UNINDENT
.sp
This environment variable forces \fBtraffic_server\fP to believe that it is being managed by
\fBtraffic_manager\fP\&.
.INDENT 0.0
.TP
.B PROXY_AUTO_EXIT
.UNINDENT
.sp
When this environment variable is set to an integral number of
seconds, \fBtraffic_server\fP will exit that many seconds after
startup. This is primarily useful for testing.
.SH SIGNALS
.INDENT 0.0
.TP
.B SIGINT, SIGTERM
On \fISIGINT\fP and \fISIGTERM\fP, \fBtraffic_server\fP exits.
.TP
.B SIGUSR1
On \fISIGUSR1\fP, \fBtraffic_server\fP logs its current memory usage.
.TP
.B SIGUSR2
On \fISIGUSR2\fP, \fBtraffic_server\fP re\-opens its standard error and standard out file descriptors.
.UNINDENT
.SH SEE ALSO
.sp
\fBtraffic_ctl(8)\fP,
\fBtraffic_manager(8)\fP
.SH COPYRIGHT
2024, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.