You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by am...@apache.org on 2020/02/15 16:13:57 UTC
[trafficserver] branch master updated: Doc: Add link from
proxy.config.proxy_binary_opts to traffic_server options. Document the
traffic_server -m, -M options, sort the options a bit better.
This is an automated email from the ASF dual-hosted git repository.
amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new 7e138b3 Doc: Add link from proxy.config.proxy_binary_opts to traffic_server options. Document the traffic_server -m, -M options, sort the options a bit better.
7e138b3 is described below
commit 7e138b34a9de9e66cfe94cd0d776b9df13e4f9a7
Author: Alan M. Carroll <am...@apache.org>
AuthorDate: Fri Feb 14 16:06:31 2020 -0600
Doc: Add link from proxy.config.proxy_binary_opts to traffic_server options.
Document the traffic_server -m, -M options, sort the options a bit better.
---
doc/admin-guide/files/records.config.en.rst | 2 +-
doc/appendices/command-line/traffic_server.en.rst | 80 ++++++++++++-----------
2 files changed, 43 insertions(+), 39 deletions(-)
diff --git a/doc/admin-guide/files/records.config.en.rst b/doc/admin-guide/files/records.config.en.rst
index a305039..dc8fdfa 100644
--- a/doc/admin-guide/files/records.config.en.rst
+++ b/doc/admin-guide/files/records.config.en.rst
@@ -193,7 +193,7 @@ System Variables
.. ts:cv:: CONFIG proxy.config.proxy_binary_opts STRING -M
- The command-line options for starting |TS|.
+ The :ref:`command-line options <traffic_server>` for starting |TS|.
.. ts:cv:: CONFIG proxy.config.manager_binary STRING traffic_manager
diff --git a/doc/appendices/command-line/traffic_server.en.rst b/doc/appendices/command-line/traffic_server.en.rst
index 7cf4a29..5abd3f4 100644
--- a/doc/appendices/command-line/traffic_server.en.rst
+++ b/doc/appendices/command-line/traffic_server.en.rst
@@ -30,46 +30,13 @@ Options
.. program:: traffic_server
-.. option:: -n COUNT, --net_threads COUNT
-
-.. option:: -U COUNT, --udp_threads COUNT
-
.. option:: -a, --accepts_thread
.. option:: -b, --accept_till_done
-.. option:: -p PORT, --httpport PORT
-
-.. option:: -f, --disable_freelist
-
-In order to improve performance, :program:`traffic_server` caches
-commonly used data structures in a set of free object lists. This
-option disables these caches, causing :program:`traffic_server` to
-use :manpage:`malloc(3)` 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.
-
-.. option:: -F, --disable_pfreelist
-
-Disable free list in ProxyAllocator which were left out by the -f
-option. This option includes the functionality of :option:`-f`.
-
-.. option:: -R LEVEL, --regression LEVEL
-
-.. option:: -r TEST, --regression_test TEST
-
-.. option:: -l, --regression_list
-
-If Traffic Server was built with tests enabled, this option lists
-the available tests.
-
-.. option:: -T TAGS, --debug_tags TAGS
-
.. option:: -B TAGS, --action_tags TAGS
-.. option:: -i COUNT, --interval COUNT
-
-.. option:: -M, --remote_management
+.. option:: -c CORE, --read_core CORE
.. option:: -C 'CMD [ARGS]', --command 'CMD [ARGS]'
@@ -116,22 +83,59 @@ help [CMD]
is passed to ``help`` then a list of the supported maintenance commands are
printed along with a brief description of each.
+.. option:: -f, --disable_freelist
+
+In order to improve performance, :program:`traffic_server` caches commonly used data structures in a
+set of free object lists. This option disables these caches, causing :program:`traffic_server` to
+use :manpage:`malloc(3)` 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.
+
+.. option:: -F, --disable_pfreelist
+
+Disable free list in ProxyAllocator which were left out by the -f option. This option includes the
+functionality of :option:`-f`.
+
+.. option:: -R LEVEL, --regression LEVEL
+
+.. option:: -r TEST, --regression_test TEST
+
+.. option:: -l, --regression_list
+
+If Traffic Server was built with tests enabled, this option lists
+the available tests.
+
+.. option:: -T TAGS, --debug_tags TAGS
+
+.. option:: -i COUNT, --interval COUNT
+
+.. option:: -m COUNT, --maxRecords
+
+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.
+
+.. option:: -M, --remote_management
+
+Indicates the process should expect to be managed by :ref:`traffic_manager`. This option should not
+be used except by that process.
+
+.. option:: -n COUNT, --net_threads COUNT
+
.. option:: -k, --clear_hostdb
.. option:: -K, --clear_cache
-.. option:: -c CORE, --read_core CORE
-
.. option:: --accept_mss MSS
.. option:: -t MSECS, --poll_timeout MSECS
-.. option:: -m RECORDS, --maxRecords RECORDS
-
.. option:: -h, --help
Print usage information and exit.
+.. option:: -p PORT, --httpport PORT
+
+.. option:: -U COUNT, --udp_threads COUNT
+
.. option:: -V, --version
Print version information and exit.