Repository: trafficserver Updated Branches: refs/heads/master 2a909df77 -> 10a361304
TS-3040: Remove traffic_shell man pages and other references Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/8ad21dea Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/8ad21dea Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/8ad21dea Branch: refs/heads/master Commit: 8ad21dea353037845e60b60bd52e425fd8fbcfaa Parents: 2a909df Author: Phil Sorber <[email protected]> Authored: Wed Nov 19 14:38:43 2014 -0700 Committer: Phil Sorber <[email protected]> Committed: Thu Nov 20 15:51:37 2014 -0700 ---------------------------------------------------------------------- doc/Makefile.am | 35 ---------- doc/admin/configuring-traffic-server.en.rst | 2 +- doc/admin/index.en.rst | 8 +-- doc/admin/monitoring-traffic.en.rst | 4 -- doc/man/show_alarms.1 | 33 --------- doc/man/show_cache-stats.1 | 60 ---------------- doc/man/show_cache.1 | 70 ------------------- doc/man/show_cluster.1 | 35 ---------- doc/man/show_dns-resolver.1 | 37 ---------- doc/man/show_dns-stats.1 | 34 --------- doc/man/show_hostdb-stats.1 | 35 ---------- doc/man/show_hostdb.1 | 40 ----------- doc/man/show_http-stats.1 | 43 ------------ doc/man/show_http-trans-stats.1 | 55 --------------- doc/man/show_http.1 | 45 ------------ doc/man/show_icp-stats.1 | 46 ------------ doc/man/show_icp.1 | 73 -------------------- doc/man/show_logging-stats.1 | 39 ----------- doc/man/show_logging.1 | 69 ------------------ doc/man/show_network.1 | 51 -------------- doc/man/show_parent.1 | 50 -------------- doc/man/show_port-tunnels.1 | 37 ---------- doc/man/show_proxy-stats.1 | 42 ----------- doc/man/show_proxy.1 | 32 --------- doc/man/show_remap.1 | 36 ---------- doc/man/show_scheduled-update.1 | 53 -------------- doc/man/show_security.1 | 37 ---------- doc/man/show_socks.1 | 47 ------------- doc/man/show_ssl.1 | 33 --------- doc/man/show_status.1 | 33 --------- doc/man/show_version.1 | 33 --------- doc/man/show_virtual-ip.1 | 35 ---------- .../configuration/records.config.en.rst | 2 +- 33 files changed, 4 insertions(+), 1280 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/Makefile.am ---------------------------------------------------------------------- diff --git a/doc/Makefile.am b/doc/Makefile.am index 5e1e919..557d8a4 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -14,40 +14,8 @@ # See the License for the specific language governing permissions and # limitations under the License. -trafficshelldir = $(pkgdocdir)/trafficshell - .PHONY: help dirhtml singlehtml epub latex man changes linkcheck doxygen -dist_trafficshell_DATA = \ - man/show_alarms.1 \ - man/show_cache.1 \ - man/show_cache-stats.1 \ - man/show_cluster.1 \ - man/show_dns-resolver.1 \ - man/show_dns-stats.1 \ - man/show_hostdb.1 \ - man/show_hostdb-stats.1 \ - man/show_http.1 \ - man/show_http-stats.1 \ - man/show_http-trans-stats.1 \ - man/show_icp.1 \ - man/show_icp-stats.1 \ - man/show_logging.1 \ - man/show_logging-stats.1 \ - man/show_network.1 \ - man/show_parent.1 \ - man/show_port-tunnels.1 \ - man/show_proxy.1 \ - man/show_proxy-stats.1 \ - man/show_remap.1 \ - man/show_scheduled-update.1 \ - man/show_security.1 \ - man/show_socks.1 \ - man/show_ssl.1 \ - man/show_status.1 \ - man/show_version.1 \ - man/show_virtual-ip.1 - if BUILD_MANPAGES man1_MANS = $(TS_MAN1_MANPAGES) @@ -64,9 +32,6 @@ all-am: $(man1_MANS) $(man3_MANS) $(man5_MANS) $(man8_MANS) endif -EXTRA_DIST = \ - $(dist_trafficshell_DATA) - clean-local: -rm -rf $(BUILDDIR)/* _build/html/* xml http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/admin/configuring-traffic-server.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/configuring-traffic-server.en.rst b/doc/admin/configuring-traffic-server.en.rst index 0e23a7c..54e7898 100644 --- a/doc/admin/configuring-traffic-server.en.rst +++ b/doc/admin/configuring-traffic-server.en.rst @@ -58,7 +58,7 @@ variables, see :ref:`configuration-variables`. Configure Traffic Server Using Configuration Files ================================================== -As an alternative to using Traffic Line or Traffic Shell, you can change +As an alternative to using Traffic Line, you can change Traffic Server configuration options by manually editing specific variables in :file:`records.config`. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/admin/index.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/index.en.rst b/doc/admin/index.en.rst index b4b7490..6886b4e 100644 --- a/doc/admin/index.en.rst +++ b/doc/admin/index.en.rst @@ -251,13 +251,9 @@ Traffic Server offers the following administration options: Traffic Line, you can execute individual commands or script a series of commands in a shell. -- The Traffic Shell (:program:`traffic_shell`) command-line interface is an - additional command-line tool that enables you to execute individual commands - that monitor and configure the Traffic Server system. - - Various configuration files enable you to configure Traffic Server through a simple file-editing and signal-handling interface. Any - changes you make through Traffic Line or Traffic Shell are + changes you make through Traffic Line is automatically made to the configuration files as well. - Finally, there is a clean C API which can be put to good use from a @@ -270,7 +266,7 @@ Traffic Analysis Options Traffic Server provides several options for network traffic analysis and monitoring: -- Traffic Line and Traffic Shell enable you to collect and process +- Traffic Line enables you to collect and process statistics obtained from network traffic information. - Transaction logging enables you to record information (in a log file) http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/admin/monitoring-traffic.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/monitoring-traffic.en.rst b/doc/admin/monitoring-traffic.en.rst index 30e04ad..f416ca0 100644 --- a/doc/admin/monitoring-traffic.en.rst +++ b/doc/admin/monitoring-traffic.en.rst @@ -39,10 +39,6 @@ performance and analyze network traffic: method of viewing Traffic Server performance and network traffic information; refer to `Viewing Statistics from Traffic Line`_. -- The Traffic Shell command-line tool provides yet another alternative - method of viewing Traffic Server performance and network traffic - information; refer to `Starting Traffic Shell <../getting-started#StartTrafficShell>`_. - Working with Traffic Manager Alarms =================================== http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_alarms.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_alarms.1 b/doc/man/show_alarms.1 deleted file mode 100644 index 372f5ac..0000000 --- a/doc/man/show_alarms.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:alarms" -.SH NAME -show:alarms \- This command displays information about active alarms. -.SH SYNOPSIS -show:alarms -.SH DESCRIPTION -The show:alarms command displays a list of active alarms. -The show:alarms command takes no options. -.SH EXAMPLE -When you execute the show:alarms command, you see results in the following format: -.PP -.nf -traffic_shell> show:alarm -Active Alarms - 1. MGMT_ALARM_PROXY_PROCESS_DIED -traffic_shell> -.SH "SEE ALSO" -config:alarms http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_cache-stats.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_cache-stats.1 b/doc/man/show_cache-stats.1 deleted file mode 100644 index 7934382..0000000 --- a/doc/man/show_cache-stats.1 +++ /dev/null @@ -1,60 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:cache-stats" -.SH NAME -show:cache-stats \- This command displays a summary of cache statistics. -.SH SYNOPSIS -show:cache-stats -.SH DESCRIPTION -The show:cache-stats command displays a summary of cache statistics, including -RAM cache, lookups, reads, writes, updates, and removes detail. The show:cache- -stats command takes no options. -.SH EXAMPLE -When you execute the show:cache-stats command, you see results in the following -format: -.PP -.nf -traffic_shell> show:cache-stats -Bytes Used --- 0 GB -Cache Size --- 0 GB ---RAM Cache-- -Total Bytes -- 0 -Bytes Used --- 0 -Hits --------- 0 -Misses ------- 0 ---Lookups-- -In Progress -- 0 -Hits --------- 0 -Misses ------- 0 ---Reads-- -In Progress -- 0 -Hits --------- 0 -Misses ------- 0 ---Writes-- -In Progress -- 0 -Hits --------- 0 -Misses ------- 0 ---Updates-- -In Progress -- 0 -Hits --------- 0 -Misses ------- 0 ---Removes-- -In Progress -- 0 -Hits --------- 0 -Misses ------- 0 -traffic_shell> -.SH "SEE ALSO" -show:cache, config:cache http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_cache.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_cache.1 b/doc/man/show_cache.1 deleted file mode 100644 index eda329d..0000000 --- a/doc/man/show_cache.1 +++ /dev/null @@ -1,70 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:cache" -.SH NAME -show:cache \- This command displays cache configuration information. -.SH SYNOPSIS -show:cache [rules | storage] -.SH DESCRIPTION -Execute the show:cache command to view basic cache configuration information, or type the servers -or access options to display access. -.SH OPTIONS -The following options are supported for the show:cache command: -.SS rules -The rules option enables you to specify the caching parameters of specific objects or sets of -objects. -.SS storage -The storage option displays the storage.confg file, which lists all the files, directories, or -hard disk partitions that make up the cache. -.SH EXAMPLES -.SS "Example 1. Displaying basic cache configuration information" -.PP -.nf -traffic_shell> show:cache -HTTP Caching --------------------------- on -Ignore User Requests To Bypass Cache --- off -Maximum HTTP Object Size ----------- NONE -Freshness - Verify Freshness By Checking --------- When The Object Has Expired - Minimum Information to be Cacheable -- Nothing - If Object has no Expiration Date: - Leave it in Cache for at least ----- 3600 s - but no more than ------------------- 86400 s -Variable Content - Cache Responses to URLs that contain - "?",";","cgi" or end in ".asp" ----- off - Alternates Enabled ------------------- off - Vary on HTTP Header Fields: - Text ------------------------------- NULL - Images ----------------------------- NULL - Other ------------------------------ NULL - Cache responses to requests containing cookies for: - Content Types which are not Text -traffic_shell> -.SS "Example 2. Displaying cache.config file rules" -.PP -.nf -traffic_shell> show:cache rules -(Displays rules from the cache.config file.) -traffic_shell> -.SS "Example 3. Displaying the storage.config file rules" -.PP -.nf -traffic_shell> show:cache storage -(Displays rules from the storage.config file.) -traffic_shell> -.SH "SEE ALSO" -config:cache http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_cluster.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_cluster.1 b/doc/man/show_cluster.1 deleted file mode 100644 index 6907c0a..0000000 --- a/doc/man/show_cluster.1 +++ /dev/null @@ -1,35 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:cluster" -.SH NAME -show:cluster \- This command displays the cluster port. -.SH SYNOPSIS -show:cluster -.SH DESCRIPTION -The show:cluster command displays the ports used for cluster communication. The -show:cluster command takes no options. -.SH EXAMPLE -.PP -When you execute the show:cluster command, you see results in the following -format: -.PP -.nf -traffic_shell> show:cluster - -Cluster Port ----------- 8086 -Cluster RS Port -------- 8088 -Cluster MC Port -------- 8089 -traffic_shell> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_dns-resolver.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_dns-resolver.1 b/doc/man/show_dns-resolver.1 deleted file mode 100644 index 63d68e1..0000000 --- a/doc/man/show_dns-resolver.1 +++ /dev/null @@ -1,37 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:dns-resolver" -.SH NAME -show:dns-resolver \- This command displays DNS Resolver configuration -information. -.SH SYNOPSIS -show:dns-resolver -.SH DESCRIPTION -The show:dns-resolver command displays the DNS Resolver configuration -information, including local domain expansion configuration (see example below). -The show:dns-resolver command takes no options. -.SH EXAMPLE -.PP -When you execute the show:dns-resolver command, you see results in the following -format: -.PP -.nf -traffic_shell> show:dns-resolver -Local Domain Expansion -- on - .com Domain Expansion --- on -traffic_shell> -.SH "SEE ALSO" -config:dns http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_dns-stats.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_dns-stats.1 b/doc/man/show_dns-stats.1 deleted file mode 100644 index db41b44..0000000 --- a/doc/man/show_dns-stats.1 +++ /dev/null @@ -1,34 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:dns-stats" -.SH NAME -show:dns-stats \- This command displays DNS statistics. -.SH SYNOPSIS -show:dns-stats -.SH DESCRIPTION -The show:dns-stats command displays DNS statistics, including DNS lookup detail. -The show:dns-stats command takes no options. -.SH EXAMPLE -.PP -When you execute the show:dns-stats command, you see results in the following -format: -.PP -.nf -traffic_shell> show:dns-stats -DNS Lookups Per Second -- 0.000000 -traffic_shell> -.SH "SEE ALSO" -config:dns http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_hostdb-stats.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_hostdb-stats.1 b/doc/man/show_hostdb-stats.1 deleted file mode 100644 index 6efe137..0000000 --- a/doc/man/show_hostdb-stats.1 +++ /dev/null @@ -1,35 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:hostdb-stats" -.SH NAME -show:hostdb-stats \- This command displays host database statistics. -.SH SYNOPSIS -show:hostdb-stats -.SH DESCRIPTION -The show:hostdb-stats command displays host database statistics, including hit -rate and DNS lookup detail. The show:hostdb-stats command takes no options. -.SH EXAMPLE -.PP -When you execute the show:hostdb-stats command, you see results in the following format: -.PP -.nf -traffic_shell> show:hostdb-stats -Host Database hit Rate -- 99.988437%I * -DNS Lookups Per Second -- 0.000000 -* Value reprensents 10 second average. -traffic_shell> -.SH "SEE ALSO" -config:hostdb http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_hostdb.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_hostdb.1 b/doc/man/show_hostdb.1 deleted file mode 100644 index 6cccfaa..0000000 --- a/doc/man/show_hostdb.1 +++ /dev/null @@ -1,40 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:hostdb" -.SH NAME -show:hostdb \- This command displays host database configuration information. -.SH SYNOPSIS -show:hostdb -.SH DESCRIPTION -The show:hostdb command displays the host database configuration information, -including various timeout values and number of retries (see example below). The -show:hostdb command takes no options. -.SH EXAMPLE -.PP -When you execute the show:hostdb command, you see results in the following format: -.PP -.nf -traffic_shell> show:hostdb -Lookup Timeout ----------- 120 s -Foreground Timeout ------- 1440 s -Background Timeout ------- 720 s -Invalid Host Timeout ----- 0 s -Re-DNS on Reload --------- off -Resolve Attempt Timeout -- 20 s -Number of retries -------- 5 -traffic_shell> -.SH "SEE ALSO" -config:hostdb http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_http-stats.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_http-stats.1 b/doc/man/show_http-stats.1 deleted file mode 100644 index 9edeef0..0000000 --- a/doc/man/show_http-stats.1 +++ /dev/null @@ -1,43 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:http-stats" -.SH NAME -show:http-stats \- This command displays HTTP protocol statistics. -.SH SYNOPSIS -show:http-stats -.SH DESCRIPTION -The show:http-stats command displays HTTP protocol statistics, including -document and header size and connections values. The show:http-stats command -takes no options. -.SH EXAMPLE -.PP -When you execute the show:http-stats command, you see results in the following format: -.PP -.nf -traffic_shell> show:http-stats ---Client-- -Total Document Bytes ----- 0 MB -Total Header Bytes ------- 0 MB -Total Connections -------- 0 -Transactins In Progress -- 0 ---Server-- -Total Document Bytes ----- 0 MB -Total Header Bytes ------- 0 MB -Total Connections -------- 0 -Transactins In Progress -- 0 -traffic_shell> -.SH "SEE ALSO" -show:cache, show:http-trans-stats, config:http http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_http-trans-stats.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_http-trans-stats.1 b/doc/man/show_http-trans-stats.1 deleted file mode 100644 index 2714fa7..0000000 --- a/doc/man/show_http-trans-stats.1 +++ /dev/null @@ -1,55 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:http-trans-stats" -.SH NAME -show:http-trans-stats \- This command displays HTTP transaction statistics. -.SH SYNOPSIS -show:http-trans-stats -.SH DESCRIPTION -The show:http-trans-stats command displays HTTP transaction statistics, -including hit, miss, and abort details. The show:http-trans-stats command takes -no options. -.SH EXAMPLE -.PP -When you execute the show:http-trans-stats command, you see results in the -following format: -.PP -.nf -traffic_shell> show:http-trans-stats -HTTP Transaction Frequency and Speeds -Transaction Type Frequency Speed(ms) ---Hits-- -Fresh ----------------------- 0.000000% 0 -Stale Revalidated ----------- 0.000000% 0 ---Misses-- -Now Cached ------------------ 0.000000% 0 -Server No Cache ------------- 0.000000% 0 -Stale Reloaded -------------- 0.000000% 0 -Client No Cache ------------- 0.000000% 0 ---Errors-- -Connection Failures --------- 0.000000% 0 -Other Errors ---------------- 0.000000% 0 ---Aborted Transactions-- -Client Aborts --------------- 0.000000% 0 -Questionable Client Aborts -- 0.000000% 0 -Partial Request Hangups ----- 0.000000% 0 -Pre-Request Hangups --------- 0.000000% 0 -Pre-Connect Hangups --------- 0.000000% 0 ---Other Transactions-- -Unclassified ---------------- 0.000000% 0 -traffic_shell> -.SH "SEE ALSO" -show:cache-stats, show:http-stats, config:http http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_http.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_http.1 b/doc/man/show_http.1 deleted file mode 100644 index 459e9b4..0000000 --- a/doc/man/show_http.1 +++ /dev/null @@ -1,45 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:http" -.SH NAME -show:http \- This command displays HTTP configuration. -.SH SYNOPSIS -show:http -.SH DESCRIPTION -Execute the show:http command to view HTTP configuration information, such as -timeouts values, header insertions, and port specifications. The show:http command -takes no options. -.SH EXAMPLE -.PP -When you execute the show:http command, you see results in the following format: -.PP -.nf -traffic_shell> show:http -HTTP Caching ------------------ on -HTTP Server Port -------------- 8080 -HTTP Other Ports -------------- NULL -Keep-Alive Timeout Inbound ---- 10 s -Keep-Alive Timeout Outbound --- 10 s -Inactivity Timeout Inbound ---- 120 s -Inactivity Timeout Outbound --- 120 s -Activity Timeout Inbound ------ 7200 s -Activity Timeout Outbound ----- 7200 s -Maximum Number of Alternates -- 3 -Remove additional headers ----- NULL -Insert Client IP Address into Header -traffic_shell> -.SH "SEE ALSO" -show:cache, show:proxy, show:proxy-stats, show:cache-stats, config:reset-stats http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_icp-stats.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_icp-stats.1 b/doc/man/show_icp-stats.1 deleted file mode 100644 index 3a2fb65..0000000 --- a/doc/man/show_icp-stats.1 +++ /dev/null @@ -1,46 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:icp-stats" -.SH NAME -show:icp-stats \- This command displays ICP statistics. -.SH SYNOPSIS -show:icp-stats -.SH DESCRIPTION -The show:icp-stats command displays ICP statistics, including query, hit, and -miss values. The show:icp-stats command takes no options. -.SH EXAMPLE -.PP -When you execute the show:icp-stats command, you see results in the following -format: -.PP -.nf -traffic_shell> show:icp-stats ---Queries Originating From This Node-- -Query Requests ----------------------------- 0 -Query Messages Sent ------------------------ 0 -Peer Hit Messages Received ----------------- 0 -Peer Miss Messages Received ---------------- 0 -Total Responses Received ------------------- 0 -Average ICP Message Response Time ---------- 0.000000 ms -Average ICP Request Time ------------------- 0.000000 ms ---Queries Originating from ICP Peers-- -Query Messages Received -------------------- 0 -Remote Query Hits -------------------------- 0 -Remote Query Misses ------------------------ 0 -Successful Response Message Sent to Peers -- 0 -traffic_shell> -.SH "SEE ALSO" -config:icp http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_icp.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_icp.1 b/doc/man/show_icp.1 deleted file mode 100644 index 36bfa0c..0000000 --- a/doc/man/show_icp.1 +++ /dev/null @@ -1,73 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:icp" -.SH NAME -show:icp \- This command displays ICP configuration. -.SH SYNOPSIS -show:icp [peers] -.SH DESCRIPTION -The show:icp command displays ICP configuration settings, including connectivity -and timeout and expiration values. The show:icp command takes no options. -.SH OPTIONS -The following option is supported for the show:icp command: -.SS peers -The peers option describes ICP parent and sibling configuration. -.SH EXAMPLES -.SS "Example 1. Displaying ICP configuration information" -.PP -.nf -traffic_shell> show:icp -ICP Mode Enabled ------- off -ICP Port --------------- 3130 -ICP Multicast Enabled -- off -ICP Query Timeout ------ 2 s -traffic_shell> -.SS "Example 2. Describing ICP parent and sibling configuration" -.PP -.nf -traffic_shell> show:icp peers -icp.config Rules -------------------- -########################################################### -# -# ICP Configuration -- Defines ICP parent/sibling configuration -# -# Each line is formatted as follows with ":" separator for each field. -# - hostname (string) -- Identifier for entry -# - host_ip_str (string) -- decimal dot notation -# - ctype (int) -- 1=Parent, 2=Sibling -# - proxy_port (int) -- TCP Port # -# - icp_port (int) -- UDP Port # -# - multicast_member -- 0=No 1=Yes -# - multicast_ip_str (string) -- decimal dot notation -# 224.0.0.0 - 239.255.255.255 -# - multicast_ttl (int) -- (1 - 2; default 1) -# -# <host>:<host IP>:<ctype>:<proxy port>:<icp port>:<MC on>:<mc IP>:<MC ttl>: -# -# Example #1 (1 parent and 1 sibling): -# ========================================================= -# host1:209.1.33.10:1:8080:3130:0:0.0.0.0:1: -# host2:209.1.33.11:2:8080:3130:0:0.0.0.0:1: -# -# -# Example #2 (1 parent and 1 sibling using MultiCast): -# ========================================================= -# host1:209.1.33.10:1:8080:3130:1:239.128.16.128:1: -# host2:209.1.33.11:2:8080:3130:1:239.128.16.128:1: -traffic_shell> -.SH "SEE ALSO" -show:icp-stats, config:icp http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_logging-stats.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_logging-stats.1 b/doc/man/show_logging-stats.1 deleted file mode 100644 index 44072f3..0000000 --- a/doc/man/show_logging-stats.1 +++ /dev/null @@ -1,39 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:logging-stats" -.SH NAME -show:logging-stats \- This command displays logging statistics. -.SH SYNOPSIS -show:logging-stats -.SH DESCRIPTION -The show:logging-stats command displays logging statistics, including storage, -events logged, and events skipped. The show:logging-stats command takes no -options. -.SH EXAMPLE -.PP -When you execute the show:logging-stats command, you see results in the -following format: -.PP -.nf -traffic_shell> show:logging-stats -Current Open Log Files ----------- 0 -Space Used For Log Files --------- 13697 -Number of Access Events Logged --- 0 -Number of Access Events Skipped -- 0 -Number of Error Events Logged ---- 0 -traffic_shell> -.SH "SEE ALSO" -config:logging http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_logging.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_logging.1 b/doc/man/show_logging.1 deleted file mode 100644 index 67847b0..0000000 --- a/doc/man/show_logging.1 +++ /dev/null @@ -1,69 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:logging" -.SH NAME -show:logging \- This command displays logging configuration information. -.SH SYNOPSIS -show:logging -.SH DESCRIPTION -The show:logging command displays logging configuration information, including -collation, management, format, and rolling configuration (see example below). -The show:logging command takes no options. -.SH EXAMPLE -.PP -When you execute the show:logging command, you see results in the following -format: -.PP -.nf -traffic_shell> show:logging -Logging Mode ----------------------------- errors and transactions -Management - Log Space Limit ------------------------ 2000 MB - Log Space Headroom --------------------- 10 MB -Log Collation ---------------------------- off - Host ----------------------------------- NULL - Port ----------------------------------- 8085 - Secret --------------------------------- foobar - Host Tagged ---------------------------- off - Space Limit for Orphan Files ----------- 25 MB -Squid Format ----------------------------- on - File Type ------------------------------ ASCII - File Name ------------------------------ squid - File Header ---------------------------- NULL -Netscape Common -------------------------- off - File Type ------------------------------ ASCII - File Name ------------------------------ common - File Header ---------------------------- NULL -Netscape Extended ------------------------ off - File Type ------------------------------ ASCII - File Name ------------------------------ extended - File Header ---------------------------- NULL -Netscape Extended2 ----------------------- off - File Type ------------------------------ ASCII - File Name ---------------------------- extended2 - File Header ---------------------------- NULL -Splitting - ICP Log Splitting ---------------------- off - HTTP Host Log Splitting ---------------- off -Custom Logs ------------------------------ off -Custom Log Definition Format ------------- Traditional -Rolling ---------------------------------- on - Roll Offset Hour ----------------------- 0 - Roll Interval -------------------------- 86400 s - Auto-delete rolled files (low space) --- on -traffic_shell> -.SH "SEE ALSO" -config:logging http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_network.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_network.1 b/doc/man/show_network.1 deleted file mode 100644 index 9fe53c9..0000000 --- a/doc/man/show_network.1 +++ /dev/null @@ -1,51 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:network" -.SH NAME -show:network \- Basic network parameters. -.SH SYNOPSIS -show:network -.SH DESCRIPTION -The show:network command displays the values for basic network parameters. The -show:network command takes no options. -.SH EXAMPLE -.PP -When you execute the show:network command, you see results in the following -format: -.PP -.nf -traffic_shell> show:network -Hostname ---------------- hostname.domain.com -Default Gateway --------- x.x.x.x -Search Domain ----------- domain.com -DNS IP Addresses--------- x.x.x.x -NIC eth0 - Status ---------------- up - Start on Boot --------- onboot - Start Protocol -------- none - IP Address ------------ x.x.x.x - Netmask --------------- x.x.x.x - Gateway --------------- default -NIC eth1 - Status ---------------- up - Start on Boot --------- onboot - Start Protocol -------- none - IP Address ------------ x.x.x.x - Netmask --------------- x.x.x.x - Gateway --------------- default -traffic_shell> -.SH "SEE ALSO" -config:network http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_parent.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_parent.1 b/doc/man/show_parent.1 deleted file mode 100644 index 811ffa1..0000000 --- a/doc/man/show_parent.1 +++ /dev/null @@ -1,50 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:parent" -.SH NAME -show:parent \- This command displays parent configuration information. -.SH SYNOPSIS -show:parent [rules] -.SH DESCRIPTION -The show:parent command displays parent configuration details, specifying -whether parent caching is enabled and identifying the parent cache, if -appropriate. The show:parent command takes an option called rules and returns -additional details. -.SH OPTIONS -.SS rules -The rules option enables you to specify the parent proxy and parent directives -for specific objects or sets of objects. -.SH EXAMPLES -When you execute the show:parent command, you see results in the following -format: -.SS "Example 1. Displaying basic parent configuration information" -.PP -.nf -traffic_shell> show:parent -Parent Caching -- off -Parent Cache ---- NULL -traffic_shell> -.SS "Example 2. Displaying parent configuration rules," -.SS " including parent directives" -.PP -.nf -traffic_shell> show:parent rules -parent.config rules -------------------- -(Displays the rules in the parent.config file.) -traffic_shell> -.SH "SEE ALSO" -config:parent http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_port-tunnels.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_port-tunnels.1 b/doc/man/show_port-tunnels.1 deleted file mode 100644 index 8a42fa8..0000000 --- a/doc/man/show_port-tunnels.1 +++ /dev/null @@ -1,37 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:port-tunnels" -.SH NAME -show:port-tunnels \- This command displays the ports through which the proxy may -tunnel. -.SH SYNOPSIS -show:port-tunnels -.SH DESCRIPTION -Execute the show:port-tunnels command to see the tunneling ports. The show:port- -tunnels command takes no options. -.SH EXAMPLE -When you execute the show:port-tunnels command, you see results in the following -format: -.PP -.nf -traffic_shell> show:port-tunnels -server-other-ports -- NULL -To view the corresponding rule of the remap.config file in the following format -map tunnel://<proxy_ip>:<port_num>/tunnel://<dest_server>:<dest_port> -use show:remap -traffic_shell> -.SH "SEE ALSO" -config:port-tunnels, show:remap http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_proxy-stats.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_proxy-stats.1 b/doc/man/show_proxy-stats.1 deleted file mode 100644 index 392c4f3..0000000 --- a/doc/man/show_proxy-stats.1 +++ /dev/null @@ -1,42 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:proxy-stats" -.SH NAME -show:proxy-stats \- This command displays a summary of proxy statistics. -.SH SYNOPSIS -show:proxy-stats -.SH DESCRIPTION -The show:proxy-stats command displays a summary of global proxy statistics, -including hit rate, bandwidth saving, open connections, and throughput. The -show:proxy-stats command takes no options. -.SH EXAMPLE -When you execute the show:proxy-stats command, you see results in the following -format: -.PP -.nf -traffic_shell> show:proxy-stats -Document Hit Rate -------- 0.000000% * -Bandwidth Saving --------- 0.000000% * -Cache Percent Free ------- 0.000000% -Open Server Connections -- 0 -Open Client Connections -- 0 -Open Cache Connections --- 0 -Client Throughput -------- 0.000000 MBit/Sec -Transaction Per Second --- 0.100000 -* Value represents 10 second average. -traffic_shell> -.SH "SEE ALSO" -show:cache, config:cache http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_proxy.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_proxy.1 b/doc/man/show_proxy.1 deleted file mode 100644 index 014dcc1..0000000 --- a/doc/man/show_proxy.1 +++ /dev/null @@ -1,32 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:proxy" -.SH NAME -show:proxy \- This command displays the proxy name. -.SH SYNOPSIS -show:proxy -.SH DESCRIPTION -Execute the show:proxy command to see the name of the proxy. The show:proxy -command takes no options. -.SH EXAMPLE -When you execute the show:proxy command, you see results in the following format: -.PP -.nf -traffic_shell> show:proxy -Name -- rubicon -traffic_shell> -.SH "SEE ALSO" -show:proxy-stats http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_remap.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_remap.1 b/doc/man/show_remap.1 deleted file mode 100644 index 9f4b380..0000000 --- a/doc/man/show_remap.1 +++ /dev/null @@ -1,36 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:remap" -.SH NAME -show:remap \- This command displays logging configuration information. -.SH SYNOPSIS -show:remap -.SH DESCRIPTION -The show:remap command displays logging configuration information, including -collation, management, format, and rolling configuration (see example below). -The show:remap command takes no options. -.SH EXAMPLE -When you execute the show:remap command, you see results in the following format -(comments included with the format example): -.PP -.nf -traffic_shell> show:remap -remap.config rules -------------------- -(Displays rules from remap.config.) -traffic_shell> -.SH "SEE ALSO" -config:remap http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_scheduled-update.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_scheduled-update.1 b/doc/man/show_scheduled-update.1 deleted file mode 100644 index 6a14452..0000000 --- a/doc/man/show_scheduled-update.1 +++ /dev/null @@ -1,53 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:scheduled-update" -.SH NAME -show:scheduled-update \- This command displays basic object-update information. -.SH SYNOPSIS -show:scheduled-update [rules] -.SH DESCRIPTION -With scheduled update, the proxy loads specific objects into the cache at scheduled times. -Execute the show:scheduled-update command to view basic object-update information, which -includes whether scheduled update is enabled, as well as error retry and concurrent update -values. -.SH OPTIONS -The following option is supported for the show:scheduled-update command: -.SS rules -The rules option displays update.config file configuration detail. The file contains a list of -URLs specifying objects that you want to schedule for update. Be aware that the system validates -these URLs for syntactic correctness, but not for existence. -.SH EXAMPLES -.SS "Example 1. Displaying basic object-update configuration" -.SS " information" -.PP -.nf -traffic_shell> show:scheduled-update -Scheduled Update ------------- off -Update Error Retry Count ----- 10 -Update Error Retry Interval -- 2 s -Maximum Concurrent Updates --- 100 -Force Immediate Update ------- off -traffic_shell> -.SS "Example 2. Displaying update.config file rules" -.PP -.nf -traffic_shell> show:scheduled-update rules -update.config rules -------------------- -(Displays rules from the update.config file.) -traffic_shell> -.SH "SEE ALSO" -config:scheduled-update http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_security.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_security.1 b/doc/man/show_security.1 deleted file mode 100644 index 20596f9..0000000 --- a/doc/man/show_security.1 +++ /dev/null @@ -1,37 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:security" -.SH NAME -show:security \- This command displays key security port assignments and the -clients and hosts that have access to Traffic Server and Traffic Server Manager. -.SH SYNOPSIS -show:security -.SH DESCRIPTION -The show:security command displays the web interface This command takes -no options. -.SH EXAMPLE -When you execute the show:security command, you see results in the following -format: -.PP -.nf -traffic_shell> show:security -Web Interface Port ----- 8081 -Overseer Port ---------- 8082 -Traffic Server Access - (ip_allow.config contents) -traffic_shell> -.SH "SEE ALSO" -config:security http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_socks.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_socks.1 b/doc/man/show_socks.1 deleted file mode 100644 index ab0c0c0..0000000 --- a/doc/man/show_socks.1 +++ /dev/null @@ -1,47 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:socks" -.SH NAME -show:socks \- This command displays SOCKS configuration information. -.SH SYNOPSIS -show:socks [rules] -.SH DESCRIPTION -Execute the show:socks command to view basic SOCKS configuration information, which include whether SOCKS is enabled, as well as default servers, version, and port values. -.SH OPTION -The following option is supported for the show:socks command: -.SS "[ rules ]" -The rules option displays SOCKS configuration detail from the socks.config file. -.SH EXAMPLES -.SS "Example 1. Displaying basic SOCKS configuration information" -.PP -.nf -traffic_shell> show:socks -SOCKS -------------------- off -SOCKS Version ------------ 4 -SOCKS Default Servers ---- s1.example.com:1080;socks2:4080 -SOCKS Accept Enabled ----- off -SOCKS Accept Port -------- 1080 -traffic_shell> -.SS "Example 2. Displaying socks.config file rules" -.PP -.nf -traffic_shell> show:socks rules -socks.config rules -------------------- -(Displays rules from the socks.config file.) -traffic_shell> -.SH "SEE ALSO" -config:socks http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_ssl.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_ssl.1 b/doc/man/show_ssl.1 deleted file mode 100644 index 25f809b..0000000 --- a/doc/man/show_ssl.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:ssl" -.SH NAME -show:ssl \- This command displays SSL port configuration. -.SH SYNOPSIS -show:ssl -.SH DESCRIPTION -The show:ssl command displays SSL port configuration information. The show:ssl -command takes no options. -.SH EXAMPLE -.SS "When you execute the show:ssl command, you see results in the" -.SS "following format" -.PP -.nf -traffic_shell> show:ssl -Restrict SSL Connections to Ports -- 443 563 -traffic_shell> -.SH "SEE ALSO" -config:ssl http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_status.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_status.1 b/doc/man/show_status.1 deleted file mode 100644 index 910761c..0000000 --- a/doc/man/show_status.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:status" -.SH NAME -show:status \- This command shows you whether the proxy is running. -.SH SYNOPSIS -show:status -.SH DESCRIPTION -If you want confirmation that the proxy is running, use the show:status command. -The show:status command has no arguments. -.SH EXAMPLE -.SS "When you execute the show:status command, you see the " -.SS "following if the proxy is on." -.PP -.nf -traffic_shell> show:status -Proxy -- on -traffic_shell> -.SH "SEE ALSO" -show:proxy, show:proxy-stats, show:cache-stats, config:reset-stats http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_version.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_version.1 b/doc/man/show_version.1 deleted file mode 100644 index 5ea92dc..0000000 --- a/doc/man/show_version.1 +++ /dev/null @@ -1,33 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:version" -.SH NAME -show:version \- This command displays Traffic Server and Traffic Manager -version information. -.SH SYNOPSIS -show:version -.SH DESCRIPTION -The show:version command displays Traffic Server and Traffic Manager -version numbers. The show:version command takes no options. -.SH EXAMPLE -When you execute the show:version command, you see results in the following -format: -.PP -.nf -traffic_shell> show:version -traffic_server version --- 5.2.0 -traffic_manager version -- 5.2.0 -traffic_shell> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/man/show_virtual-ip.1 ---------------------------------------------------------------------- diff --git a/doc/man/show_virtual-ip.1 b/doc/man/show_virtual-ip.1 deleted file mode 100644 index ca37c5a..0000000 --- a/doc/man/show_virtual-ip.1 +++ /dev/null @@ -1,35 +0,0 @@ -.\" Licensed to the Apache Software Foundation (ASF) under one .\" -.\" or more contributor license agreements. See the NOTICE file .\" -.\" distributed with this work for additional information .\" -.\" regarding copyright ownership. The ASF licenses this file .\" -.\" to you under the Apache License, Version 2.0 (the .\" -.\" "License"); you may not use this file except in compliance .\" -.\" with the License. You may obtain a copy of the License at .\" -.\" .\" -.\" http://www.apache.org/licenses/LICENSE-2.0 .\" -.\" .\" -.\" Unless required by applicable law or agreed to in writing, software .\" -.\" distributed under the License is distributed on an "AS IS" BASIS, .\" -.\" WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. .\" -.\" See the License for the specific language governing permissions and .\" -.\" limitations under the License. .\" -.TH "show:virtual-ip" -.SH NAME -show:virtual-ip \- This command displays virtual IP configuration information -.SH SYNOPSIS -show:virtual-ip -.SH DESCRIPTION -The show:virtual-ip command displays the virtual IP addresses configured for -your system. The show:virtual-ip command takes no options. -.SH EXAMPLE -.SS "When you execute the show:virtual-ip command, you see results" -.SS "in the following format." -.PP -.nf -traffic_shell> show:virtual-ip - 2 Elements in Record - 0 1.1.1.1 23 23 - 1 1.1.1.1 23 24 -traffic_shell> -.SH "SEE ALSO" -config:virtual-ip http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ad21dea/doc/reference/configuration/records.config.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst index 0fbdd2d..cbb6db6 100644 --- a/doc/reference/configuration/records.config.en.rst +++ b/doc/reference/configuration/records.config.en.rst @@ -25,7 +25,7 @@ The :file:`records.config` file (by default, located in ``/opt/trafficserver/etc/trafficserver/``) is a list of configurable variables used by the Traffic Server software. Many of the variables in the :file:`records.config` file are set automatically when you set configuration -options in Traffic Line or Traffic Shell. After you modify the +options in Traffic Line. After you modify the :file:`records.config` file, run the command :option:`traffic_line -x` to apply the changes. When you apply changes to one node in a cluster, Traffic Server
