Repository: trafficserver Updated Branches: refs/heads/master a0733c40f -> 2369a1a49
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_logging.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_logging.1 b/doc/man/config_logging.1 deleted file mode 100644 index d00934b..0000000 --- a/doc/man/config_logging.1 +++ /dev/null @@ -1,160 +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 "config:logging" -.SH NAME -config:logging \- Enables and configures logging parameters. -.SH SYNOPSIS -config:logging [options] -.SH DESCRIPTION -Use the config:logging command to enable and configure logging. Use the -config:logging command to specify format, type, storage, splitting, rolling, and -other parameters. When you execute the config:logging command, you must use one -of the options described below. -.SH OPTIONS -The following options are supported for the config:logging command: -.SS "event <enabled | trans-only | error-only | disabled>" -Enables and disables event logging. Type trans-only to log only transactions. -Type error-only to log only errors. Type enabled to enable full logging that -includes errors and transactions. Type disabled to disable logging completely. -(The default value is enabled.) -.SS "mgmt-directory <dir>" -Specifies the full path to the logging directory. (The default is -/home/inktomi/5.0.0/logs.) -.SS "space-limit <mb>" -Specifies the amount of space allocated to the logging directory in MB. (The -default value is 2000MB.) -.SS "space-headroom <mb>" -Specifies the tolerance for the log space limit.(The default value is 10MB.) -.SS "collation-status <inactive | host | send-standard | send-custom | send-all>" -Specifies the log collation mode. Type inactive to disable collation. Type host -to specify the local host as a collation server. Type send-standard to specify -the local host as collation client that sends entries using standard formats to -the collation server. Type send-custom to specify this host as a collation -client that sends entries using the traditional custom formats to the collation -server. Type send-all to specify this host as a collation client that sends -entries that use both the standard and traditional custom formats to the -collation server. (The default value is inactive.) -.SS "collation-host <host>" -Specifies the hostname of the log collation server. (The default value is NULL.) -.SS "collation secret <secret> tagged <on | off> orphan-limit <orphan>" -Specifies the password used to validate logging data and prevent the exchange of -unauthorized information when a collation server is being used. (The default -value is foobar.) -Specifies the tagged option in log entry. When enabled (on), configures Traffic Server to include the hostname of the collation client that generated the log entry in each entry. (The default value is off.) -Specifies the storage limit for orphan files in MB. (The default value is -25.) -.SS "format <squid | netscape-common | netscape-ext | netscape-ext2> <on|off> type <ascii | binary> file <file> header <header>" -Specifies which logging formats you want on/off. Also specifies the log file -type (ASCII or binary), file name, and header text. The default log file format -(on) is the Squid format. The default values for all formats are as follows: -.PP -.nf -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 - -.SS "splitting <icp | http> <on | off>" -Enables (on) or disables (off) log splitting for ICP, and HTTP. When -enabled, the proxy stores the transactions for the protocol you choose in a -separate log file. (The default value is off for ICP and HTTP.) -.SS"custom <on | off> format <traditional | xml>" -Enables (on) or disables (off) custom logging. When you enable custom logging, -you must specify the format, traditional or XML. (The default values are off for -custom logging and traditional for format.) -.SS "rolling <on | off> offset <hour> interval <num-hours> auto-delete <on | off>" -Enables (on) or disables (off) log file rolling. (The default value is on.) -The offset <hour> parameter specifies the hour of the day that starts the log -rolling period. (The default value is 0.) The interval <num-hours> parameter -specifies the log file rolling interval. (The default value is 86400 seconds.) -The auto-delete <on | off> parameter enables (on) or disables (off) the -automatic deletion of rolled log files. (The default value is on.) -.SH EXAMPLES -.SS "Example 1. Enabling error and transaction logging" -.PP -.nf -traffic_shell> config:logging event enabled -traffic_shell> -.SS "Example 2. Specifying the full path to the logging directory" -.PP -.nf -traffic_shell> config:logging mgmt-directory /home/inktomi/rc4/logs -traffic_shell> -.SS "Example 3. Specifying logging directory storage allocation (MB)" -.PP -.nf -traffic_shell> config:logging space-limit 10 -traffic_shell> -.SS "Example 4. Specifying the tolerance for the log space limit" -.PP -.nf -traffic_shell> config:logging space-headroom 100 -traffic_shell> -.SS "Example 5. Configuring the host to send entries using the " -.SS " traditional custom formats to the collation server" -.PP -.nf -traffic_shell> config:logging collation-status send-custom -traffic_shell> -.SS "Example 6. Specifying the hostname (jupiter) of the log" -.SS " collation server" -.PP -.nf -traffic_shell> config:logging collation-host jupiter -traffic_shell> -.SS "Example 7. Specifying the password used to validate logging" -.SS " data, configuring logging to include the hostname" -.SS " of the collation, and specifying 10MB as the " -.SS " storage limit for orphan files" -.PP -.nf -traffic_shell> config:logging collation secret foobar tagged on orphan-limit 10 -traffic_shell> -.SS "Example 8. Enabling the Squid logging format, and specifying" -.SS " the ASCII file type and squid.log file name" -.PP -.nf -traffic_shell> config:log format squid on type ascii file squid.log -traffic_shell> -.SS "Example 9. Enabling custom XML logging" -.PP -.nf -traffic_shell> config:logging custom on format xml -traffic_shell> -.SS "Example 10. Enabling log rolling, to begin rolling at " -.SS " midnight, with an interval of 60 seconds and" -.SS " no automatic deletion of rolled files" -.PP -.nf -traffic_shell> config:logging rolling on offset 0 interval 1 auto-delete off -traffic_shell> -.SH "SEE ALSO" -show:logging, show:logging-stats http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_name.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_name.1 b/doc/man/config_name.1 deleted file mode 100644 index c85e47a..0000000 --- a/doc/man/config_name.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 "config:name" -.SH NAME -config:name \- Sets the name of the proxy. -.SH SYNOPSIS -config:name [hostname] -.SH DESCRIPTION -The config:name command enables you to set the name of your proxy system. -.SH OPERANDS -The following operand is supported: -.SS "<proxyname>" -The hostname is your name for your proxy system. -.SH EXAMPLES -.SS "When you execute the config:name command, you see " -.SS "results in the following format:" -.PP -.nf -traffic_shell> config:name somename -somename.yourdomain.com -traffic_shell> -.SH "SEE ALSO" -show:network http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_network.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_network.1 b/doc/man/config_network.1 deleted file mode 100644 index db638b3..0000000 --- a/doc/man/config_network.1 +++ /dev/null @@ -1,75 +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 "config:network" -.SH NAME -config:network \- Configures system network settings. -.SH SYNOPSIS -config:network [options] -.SH DESCRIPTION -The config:network command enables you to configure network settings such as hostname, -defaultrouter, search-domain, dns, and interface settings. -You must use one of the options described below. -.SH OPTIONS -The following options are supported for the config:network command: -.SS "hostname <string>" -Specifies the fully qualified hostname. -.SS "defaultrouter <x.x.x.x>" -Specifies the IP address of the default router. -.SS "search-domain <string>" -Specifies the search domain. -.SS "dns <a.a.a.a b.b.b.b c.c.c.c>" -Specifies the IP addresses of one or more DNS servers. -.SS "int" -Displays the Network Interfaces. -.SS "int <interface>" -Displays information pertaining to a Network Interface. -.SS "int <interface> down" -Bring down a Network Interface. -.SS "int <interface> up <onboot | not-onboot> <static | dhcp> <ip> <netmask> <gateway>" -Bring up a Network Interface with the specified settings: boot status, static IP versus DHCP, IP address, netmask, and gateway IP (or default). -.SS "int <interface> <onboot | not-onboot>" -Specify the boot status of a Network Interface. NIC must already be up. -.SS "int <interface> <static | dhcp> -Specify static IP or DHCP for a Network Interface. NIC must already be up. -.SS "int <interface> ip <x.x.x.x>" -Specify the IP address of a network interface. NIC must already be up. -.SS "int <interface> netmask <x.x.x.x>" -Specify the netmask of a network interface. NIC must already be up. -.SS "int <interface> gateway <x.x.x.x | default>" -Specify the gateway IP address, or default to use the defaultrouter. -.SH EXAMPLES -.SS "Example 1. Specifying the hostname" -.PP -.nf -traffic_shell> config:network hostname host.example.com -traffic_shell> -.SS "Example 2. Specifying multiple DNS servers" -.PP -.nf -traffic_shell> config:network dns "x.x.x.x y.y.y.y z.z.z.z" -traffic_shell> -.SS "Example 3. Listing the Network Interfaces" -traffic_shell> config:network int -eth0 -eth1 -traffic_shell> -.SS "Example 4. Bringing up a Network Interface with IP address x.x.x.x and netmask y.y.y.y" -.PP -.nf -traffic_shell> config:network int eth0 onboot static x.x.x.x y.y.y.y default -traffic_shell> -.SH "SEE ALSO" -show:network http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_parent.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_parent.1 b/doc/man/config_parent.1 deleted file mode 100644 index ae39549..0000000 --- a/doc/man/config_parent.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 "config:parent" -.SH NAME -config:parent \- Configure parent proxy caching. -.SH SYNOPSIS -config:parent [options] -.SH DESCRIPTION -You use the config:parent command to enable HTTP parent caching, specify a -parent cache, and indicate where the proxy should locate the parent.config file, -which contains specific parent cache configuration information. -.SH OPTIONS -The following options are supported for the config:parent command: -.SS "status <on | off>" -Enables (on) or disables (off) the HTTP parent caching option. (The default -value is off.) -.SS "name <parent>" -Specifies the parent cache. (The default value is NULL.) -.SS "rules <url>" -Specifies from which location (URL) the proxy should retrieve and install your -parent.config file. -.SH EXAMPLES -.SS "Example 1. Enabling HTTP parent caching" -.PP -.nf -traffic_shell> config:parent status on -traffic_shell> -.SS "Example 2. Specifying the parent cache" -.PP -.nf -traffic_shell> config:parent name www.example.com -traffic_shell> -.SS "Example 3. Locating the access file to specify administrators" -.SS " with access to the Traffic Manager UI" -.PP -.nf -traffic_shell> config:parent rules http://somedomain.com/path/parent.config -traffic_shell> -.SH "SEE ALSO" -show:parent http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_port-tunnels.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_port-tunnels.1 b/doc/man/config_port-tunnels.1 deleted file mode 100644 index 5dd4102..0000000 --- a/doc/man/config_port-tunnels.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 "config:port-tunnels" -.SH NAME -config:port-tunnels \- Configures port tunnels. -.SH SYNOPSIS -config:port-tunnels [server-other-ports] -.SH DESCRIPTION -Use the config:port-tunnels command to specify a port for the proxy to use for -tunneling. -.SH OPTIONS -The following option is supported for the config:port-tunnels command: -.SS "server-other-ports <port>" -Specifies a port for tunneling. (The default value is NULL.) -.SH EXAMPLE -.SS "Specifying a port for the proxy to use for tunneling" -.PP -.nf -traffic_shell> config:port-tunnels server-other-ports 5678 -traffic_shell> -.SH "SEE ALSO" -show:port-tunnels, show:remap http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_remap.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_remap.1 b/doc/man/config_remap.1 deleted file mode 100644 index 7d18580..0000000 --- a/doc/man/config_remap.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 "config:remap" -.SH NAME -config:remap \- Specify the location of your remap.config file. -.SH SYNOPSIS -config:remap [url] -.SH DESCRIPTION -You use the config:remap command to specify from which location (URL) the proxy -should retrieve and install your remap.config file. -.SH OPERAND -The following operand is supported for the config:remap command: -.SS "<url>" -Specifies the location of your remap.config file. -.SH EXAMPLE -.SS "Specifying the location of your remap.config file" -.PP -.nf -traffic_shell> config:remap http://somedomain.com/path/remap.config -traffic_shell> -.SH "SEE ALSO" -show:remap http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_reset-stats.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_reset-stats.1 b/doc/man/config_reset-stats.1 deleted file mode 100644 index 2b09e2a..0000000 --- a/doc/man/config_reset-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 "config:reset-stats" - -.SH NAME - -config:reset-stats \- Resets all statistics. - -.SH SYNOPSIS - -config:reset-stats - -.SH DESCRIPTION - -The config:reset-stats command resets all statistics. (See the "See Also" -section below for a list of commands that display statistics.) The config:reset- -stats command takes no options. - -.SH EXAMPLES - -.TP - -When you execute the config:reset-stats command, you see results in the -following format: - -.TP -ts_shell>config:reset-stats - +OK -ts_shell> - -.SH "SEE ALSO" -show:cache-stats, show:dns-stats, show:hostdb-stats, show:http-stats, -show:proxy-stats, show:http-trans-stats, show:icp-stats, show:logging-stats http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_restart.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_restart.1 b/doc/man/config_restart.1 deleted file mode 100644 index cc4e979..0000000 --- a/doc/man/config_restart.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 "config:restart" -.SH NAME -config:restart \- Restarts the proxy software. -.SH SYNOPSIS -config:restart [options] -.SH DESCRIPTION -The config:restart command restarts your proxy software. When you execute the -config:restart command, you may use one of the options described below. -.SS "cluster" -Specifies cluster-wide restart. -.SH EXAMPLES -When you execute the config:restart command, you see results in the following format. -.PP -.nf -traffic_shell> config:restart -traffic_shell> -.SH "SEE ALSO" -config:start, config:stop, config:hard-restart http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_root.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_root.1 b/doc/man/config_root.1 deleted file mode 100644 index e527c51..0000000 --- a/doc/man/config_root.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 "config:root" -.SH NAME -config:root \- Switch to root user. -.SH SYNOPSIS -config:root -.SH DESCRIPTION -If you want to become the root user type the config:root command. -You will be prompted to enter the root password. The config:root command takes no options. -.SH EXAMPLE -.TP -.fi -When you execute the config:root command, you see the following: -.PP -.nf -traffic_shell> config:root -Password: (enter password) -traffic_shell# -.SH "SEE ALSO" -enable, disable, exit http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_scheduled-update.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_scheduled-update.1 b/doc/man/config_scheduled-update.1 deleted file mode 100644 index 3b82434..0000000 --- a/doc/man/config_scheduled-update.1 +++ /dev/null @@ -1,84 +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 "config:scheduled-update" -.SH NAME -config:scheduled-update \- Enables and configures the scheduled update option. -.SH SYNOPSIS -config:scheduled-update [options] -.SH DESCRIPTION -When you enable scheduled update, the proxy can automatically update certain -objects in the local cache at a specified time. When you execute the -config:scheduled-update command, you must use one of the options described -below. -.SH OPTIONS -The following options are supported for the config:scheduled-update command: -.SS "status <on | off>" -Enables (on) or disables (off) the scheduled update option. When this option is -enabled, the proxy can automatically update certain objects in the local cache -at a specified time. (The default value is disabled.) -.SS "retry-count <integer>" -The retry count specifies the number of times the proxy can retry the scheduled -update of a URL in the event of failure. (The default value is 10.) -.SS "retry-interval <seconds>" -The interval specifies the delay in seconds between each scheduled update retry for a URL in -the event of failure. (The default value is 2 seconds.) -.SS "max-concurrent <integer>" -Specifies the maximum number of simultaneous update requests allowed at any -point in time. This option prevents the scheduled update process from -overburdening the host. (The default value is 100.) -.SS "force-immediate <on | off>" -Enables (on) or disables (off) a force immediate update. When enabled, the proxy -overrides the scheduling expiration time for all scheduled update entries and -initiates updates until this option is disabled.(The default value is disabled.) -.SS "rules <url>" -Specifies the location (URL) from which the proxy should retrieve your scheduled -update rules file. The proxy retrieves your rules file and saves it locally as -update.config. The update.config file controls how the proxy performs a -scheduled update of specific local cache content. -Once you use the rules option with a URL, thereby saving your update.config -file, you can use the rules option (without typing a URL) to display the -update.config file. -.SH EXAMPLES -.SS "Example 1. Enabling the scheduled update option" -.PP -.nf -traffic_shell> config:scheduled-update on -traffic_shell> -.SS "Example 2. Specifying the number of retries allowed in case of failure and the delay between each retry" -.PP -.nf -traffic_shell> config:scheduled-update retry count 10 interval 2 -traffic_shell> -.SS "Example 3. Disabling the force immediate updates option" -.PP -.nf -traffic_shell> config:scheduled-update force-immediate off -traffic_shell> -.SS "Example 4. Specifying the location (URL) from which the proxy should retrieve your scheduled update rules file to be saved locally as the update.config file" -.PP -.nf -traffic_shell> config:scheduled-update rules http://somedomain.com/~path/rulesfile -traffic_shell> -.SS "Example 5. Displaying the update.config file" -.PP -.nf -traffic_shell> config:scheduled-update rules - update.config rules - ------------------- - (Displays the rules from the update.config file.) -traffic_shell> -.SH "SEE ALSO" -show:scheduled-update http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_security.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_security.1 b/doc/man/config_security.1 deleted file mode 100644 index b3e2381..0000000 --- a/doc/man/config_security.1 +++ /dev/null @@ -1,52 +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 "config:security" -.SH NAME -config:security \- This command enables you to apply Traffic Server and Traffic -Manager access configuration file settings to Traffic Server. -.SH SYNOPSIS -config:security [ip-allow | mgmt-allow | admin] [url-config-file] -.SH DESCRIPTION -The config:security command enables you to indicate from what URL Traffic Server -should retrieve the configuration file (IP_allow) that controls client access to -the Traffic Server proxy cache. The command also enables you to indicate from -what URL Traffic Server should retrieve the configuration file (mgmt_allow) that -controls remote host access to the Traffic Manager UI. Finally, the -config:security command enables you to indicate from what URL Traffic Server -should retrieve the configuration file (admin) (password) that controls -administrator access to Traffic Manager activities. -.SH OPTIONS -The following options are supported for the config:security command: -.SS "ip-allow <url>" -Specifies the configuration file that controls client access to the Traffic -Server proxy cache. -.SS "mgmt-allow <url>" -Specifies the configuration file that controls remote host access to the Traffic -Manager UI. -.SS "admin <url>" -Specifies the configuration file that controls administrator access to Traffic -Manager activities. -.SS "password <string>" -Specifies the administrator password that the administrator must use to access -the Traffic Manager UI. -.SH EXAMPLES -.SS "Example 1. Locating the access file to specify client access" -.PP -.nf -traffic_shell> config:security ip-allow http://something.com/ip_allow.config -traffic_shell> -.SH "SEE ALSO" -show:security http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_set.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_set.1 b/doc/man/config_set.1 deleted file mode 100644 index 9d08faa..0000000 --- a/doc/man/config_set.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 "config:set" -.SH NAME -config:set \- Sets the value of a variable. -.SH SYNOPSIS -config:set [variable] -.SH DESCRIPTION -The config:set command enables you to set the value of a variable from the -records.config file. -.SH OPERANDS -The following operand is supported: -.SS "<variable> <value>" -You must type the name of the records.config file variable for which you want to -set a value. -.SH EXAMPLES -When you execute the config:set command, you see results in the following format: -.PP -.nf -traffic_shell> config:set proxy.config.http.server_port 8080 -traffic_shell> -.SH "SEE ALSO" -config:get http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_socks.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_socks.1 b/doc/man/config_socks.1 deleted file mode 100644 index c2f6839..0000000 --- a/doc/man/config_socks.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 "config:socks" -.SH NAME -config:socks \- Enable and configure SOCKS. -.SH SYNOPSIS -config:socks [options] -.SH DESCRIPTION -You use the config:socks command to enable the SOCKS option and configure SOCKS -parameters, including default servers, version, and port values. -.SH OPTIONS -The following options are supported for the config:socks command: -.SS "status <on | off>" -Enables (on) or disables (off) the SOCKS option. (The default value is -disabled.) -.SS "version <integer>" -Specifies the SOCKS version number. -.SS "default-servers <string>" -Specifies the IP address of the SOCKS server. -.SS "accept <on | off>" -Specifies whether SOCKS accept is on or off. -.SS "accept-port <integer>" -Specifies the port used by the proxy to communicate with the SOCKS server. (The -default value is 1080.) -.SH EXAMPLES -.SS "Example 1. Enabling the SOCKS option" -.PP -.nf -traffic_shell> config:socks mode on -traffic_shell> -.SS "Example 2. Specifying the SOCKS server IP address" -.PP -.nf -traffic_shell> config:socks server-ip 209.1.1.1 -traffic_shell> -.SS "Example 3. Specifying the port used by the proxy to communicate with the SOCKS server" -.PP -.nf -traffic_shell> config:socks port 1080 -traffic_shell> -.SS "Example 4. Specifying the timeout duration for the proxy to wait for a SOCKS server response" -.PP -.nf -traffic_shell> config:socks timeout 100 -traffic_shell> -.SH "SEE ALSO" -show:socks http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_ssl.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_ssl.1 b/doc/man/config_ssl.1 deleted file mode 100644 index 8f7d4e9..0000000 --- a/doc/man/config_ssl.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 "config:ssl" -.SH NAME -config:ssl \- Configures SSL protocol settings. -.SH SYNOPSIS -config:ssl [options] -.SH DESCRIPTION -The config:ssl command enables you to configure SSL protocol settings -through a variety of options. -You must use one of the options described below. -.SH OPTIONS -The following options are supported for the config:ssl command: -.SS "status <on | off>" -Enables (on) or disables (off) SSL connections. -.SS "ports <portno>" -Specifies the port number for SSL. -.SH EXAMPLES -.SS "Example 1. Enabling SSL" -.PP -.nf -traffic_shell> config:ssl status on -traffic_shell> -.SS "Example 2. Specifying the SSL port number" -.PP -.nf -traffic_shell> config:ssl port 4443 -traffic_shell> -.SH "SEE ALSO" -show:ssl http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_start.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_start.1 b/doc/man/config_start.1 deleted file mode 100644 index 28be29b..0000000 --- a/doc/man/config_start.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 "config:start" -.SH NAME -config:start \- Starts the proxy software. -.SH SYNOPSIS -config:start -.SH DESCRIPTION -The config:start command starts your proxy software. The config:start command -takes no options. -.SH EXAMPLES -When you execute the config:start command, you see results in the following -format: -.PP -.nf -traffic_shell> config:start -traffic_shell> -.SH "SEE ALSO" -config:stop, config:restart, config:hard-restart http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_stop.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_stop.1 b/doc/man/config_stop.1 deleted file mode 100644 index e7b15ea..0000000 --- a/doc/man/config_stop.1 +++ /dev/null @@ -1,31 +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 "config:stop" -.SH NAME -config:stop \- Stops the proxy software. -.SH SYNOPSIS -config:stop -.SH DESCRIPTION -The config:stop command stops your proxy software. The config:stop command takes -no options. -.SH EXAMPLES -When you execute the config:stop command, you see results in the following format. -.PP -.nf -traffic_shell> config:stop -traffic_shell> -.SH "SEE ALSO" -config:start, config:restart, config:hard-restart http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_upgrade.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_upgrade.1 b/doc/man/config_upgrade.1 deleted file mode 100644 index c393559..0000000 --- a/doc/man/config_upgrade.1 +++ /dev/null @@ -1,52 +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 "config:upgrade" -.SH NAME -config:upgrade \- Perform an over-the-wire software upgrade. -.SH SYNOPSIS -config:upgrade <upgrade-type> <url> [username] [password] -.SH DESCRIPTION -You use the config:upgrade command to perform over-the-wire software upgrades. -This command supports three types of upgrades: silent, interactive, and reinstall. -When you use this command, you must specify an upgrade server URL, -and optionally specify a username and password. This command requires root privileges. -Use the config:root command to switch to root user. -.SH OPTIONS -The following options are required for the config:upgrade command: -.SS "<silent | interactive | reinstall>" -Silent upgrade automatically chooses the appropriate upgrade from the upgrade server. -Interactive upgrade allows you to choose the upgrade package from a list. -Reinstall allows you to install an older version of software with default -configuration settings. -.SS "<url>" -Specifies the URL which is the location of the upgrade files on a remote -server.If the URL is for HTTP or HTTPS, then username and password are optional. -.SS "<username>" -Specifies the username that is used to access the URL on the remote server. -.SS "<password>" -Specifies the password that is used to access the URL on the remote server. -If a username is specified, but the password is omitted, then the config:upgrade command -will prompt you to enter a password. - -.SH EXAMPLES -.SS "Example 1. Perform a silent upgrade" -.PP -.nf -traffic_shell> config:upgrade silent http://upgradeserver.domain.com user password -(Upgrade command status messages) -traffic_shell> -.SH "SEE ALSO" -config:root http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/config_virtual-ip.1 ---------------------------------------------------------------------- diff --git a/doc/man/config_virtual-ip.1 b/doc/man/config_virtual-ip.1 deleted file mode 100644 index 62f4e55..0000000 --- a/doc/man/config_virtual-ip.1 +++ /dev/null @@ -1,52 +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 "config:virtual-ip" -.SH NAME -config:virtual-ip \- Enables and configures virtual IP addressing. -.SH SYNOPSIS -config:virtual-ip [options] -.SH DESCRIPTION -You use the config:virtual-ip command to enable and configure virtual IP -addressing, including IP address, device, and subinterface. -.SH OPTIONS -The following options are supported for the config:virtual-ip command: -.SS "status <on | off>" -Enables (on) or disables (off) the virtual IP option. (The default value is -off.) -.SS "list" -List the virtual IP addresses in use. -.SS "add <ip_address> device <string> sub-intf <integer>" -Specifies IP address, device and subinterface. -.SS "delete <integer>" -Specified Virtual IP address element to be deleted. -.SH EXAMPLES -.SS "Example 1. Enabling the virtual IP option" -.PP -.nf -traffic_shell> config:virtual-ip on -traffic_shell> -.SS "Example 2. Specifying an IP address, device, and subinterface" -.PP -.nf -traffic_shell> config:virtual-ip add ip 202.112.105.89 device hme0 sub-intf 28 -traffic_shell> -.SS "Example 3. Deleting a virtual IP address." -.PP -.nf -traffic_shell> config:virtual-ip delete 1 -traffic_shell> -.SH "SEE ALSO" -show:virtual-ip http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/disable.1 ---------------------------------------------------------------------- diff --git a/doc/man/disable.1 b/doc/man/disable.1 deleted file mode 100644 index 1254d84..0000000 --- a/doc/man/disable.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 "disable" -.SH NAME -disable \- Disable privileged commands. -.SH SYNOPSIS -disable -.SH DESCRIPTION -If you are in Configure mode and want to return to Monitor mode, type -the disable command. The disable command has no options. -.SH EXAMPLE -.TP -.fi -When you execute the disable command, you see the following: -.PP -.nf -traffic_shell> disable -traffic_shell> -.SH "SEE ALSO" -enable, config:root, exit http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/enable.1 ---------------------------------------------------------------------- diff --git a/doc/man/enable.1 b/doc/man/enable.1 deleted file mode 100644 index bb60cb6..0000000 --- a/doc/man/enable.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 "enable" -.SH NAME -enable \- Enable privileged commands. -.SH SYNOPSIS -enable -.SH DESCRIPTION -If you are in Monitor mode and want to enter Configure mode, type -the enable command. You will be prompted to enter the administrator password. -.SH OPTIONS -The following options are supported for the enable command: -.SS "status" -Display the enable status, on or off. -.SH EXAMPLE -.TP -.fi -When you execute the enable command, you see the following: -.PP -.nf -traffic_shell> enable status -off -traffic_shell> enable -Password: (enter password) -traffic_shell> enable status -on -traffic_shell> -.SH "SEE ALSO" -config:root, disable, exit http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/exit.1 ---------------------------------------------------------------------- diff --git a/doc/man/exit.1 b/doc/man/exit.1 deleted file mode 100644 index 33e4e96..0000000 --- a/doc/man/exit.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 "exit" -.SH NAME -exit \- Type exit to end your CLI session. -.SH SYNOPSIS -exit -.SH DESCRIPTION -Use the exit command while in show or configure mode to end your CLI -session. After you use the exit command, you return to your normal UNIX -prompt. The exit command has no options. -.SH EXAMPLE -.PP -.fi -When you execute the exit command, you see results in the following format: -.PP -traffic_shell> exit -.TP -[username@hostname bin]# -.SH "SEE ALSO" -enable, disable http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2369a1a4/doc/man/traffic_shell.1 ---------------------------------------------------------------------- diff --git a/doc/man/traffic_shell.1 b/doc/man/traffic_shell.1 deleted file mode 100644 index abbd68c..0000000 --- a/doc/man/traffic_shell.1 +++ /dev/null @@ -1,165 +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. .\" -.Dd January 22, 2012 -.Dt TRAFFIC.ShELL 1 -.sp -.Sh NAME -.Nm traffic_shell -.Nd Traffic Server configuration shell -.sp -.Sh SYNOPSIS -.Nm -.Op Fl V -.Op Ar filename -.sp -.Sh DESCRIPTION -.Nm -is a command-line interface to monitor and configure Apache Traffic Server. -.Nm -enables you to monitor and configure Traffic Server using a -UNIX shell-like command interface. Using -.Nm -is an alternative to manually editing Traffic Server's configuration -files or using the -.Xr traffic_line 1 -interface. -.Pp -You use -.Nm -interactively by typing individual commands at the -.Li trafficserver> -prompt. As you enter a command, -.Nm -processes it -and displays the result. -.Nm -embeds a Tcl interpreter, so you can use the Tcl language to display status or -make configuration changes programmatically. -.Pp -When invoked with the -.Ar filename -argument, -.Nm -will read and execute commands from the given file prior to entering interactive -mode. -.sp -.Sh USING TRAFFIC SHELL COMMANDS -Once you start -.Nm -, you use one of two modes: -.Pp -The Monitor mode allows you to run Show commands, which display system -information and Traffic Server statistics. You use Show commands to monitor -Traffic Server performance. When you start -.Nm , -you are automatically in Monitor mode. -.Pp -To see a list of Show commands, type -.Sq show -at the prompt. To use a Show command, enter the command at the -.Li trafficserver> -prompt. -.Pp -The Enable mode allows you to run Config commands, which set Traffic Server -and network parameters. The Enable mode is password-protected. To enter Enable -mode use the -.Sq enable -command. -.Pp -You must enter Enable mode to use Config commands. You can use both -Show and Config commands when you are in Enable mode. It is not -necessary to return to Monitor mode to use Show commands. -.Pp -Once you enter Enable mode, you can use the Config commands. To -see a list of Config commands, type -.Sq config -at the -.Li trafficserver> -prompt. To use a Config command, enter the command at the prompt. -.Pp -To return to Monitor mode, in which you cannot use Config commands to -set parameters, use the -.Sp disable -command. -.Pp -Type -.Sq exit -at the -.Li trafficserver> -prompt to exit -.Nm . -.sp -.Sh TRAFFIC SHELL COMMAND SHORTCUTS -.Nm -supports the following shortcuts for entering commands. -.Bl -bullet -.It -Command completion. Type the initial characters of a valid command, and then -press the tab key. Traffic Shell completes the command. -.It -Command abbreviation. Type the initial characters of a valid command, and then -press the Enter key. -.Nm -displays all commands that begin with the characters that you -enter. If only one command begins with those characters, -.Nm -immediately executes that command. -.It -Command history. From the -.Li trafficserver> -prompt, press the Up and Down arrow keys to scroll -through commands that you previously entered. -.El -.sp -.Sh ACCESSING ON-LINE HELP -.Nm -includes manual pages that describe each command. To access -.Nm -'s man pages, type -.Sq help , -followed by any -.Nm -command at the prompt. -.Sh OPTIONS -.Bl -tag -width indent -.It Fl V -Print version information and exit. -.El -.sp -.Sh EXAMPLES -Displaying the on-line help for a command: -.Bd -ragged -offset 12345678 -trafficserver> help show:security -.Ed -.Pp -Use a monitor command to show a Traffic Server configuration setting: -.Bd -ragged -offset 12345678 -trafficserver> show:http -.Ed -.Pp -Use a config command to alter a Traffic Server configuration setting: -.Bd -ragged -offset 12345678 -trafficserver> config:icp multicast on -.Ed -.Pp -Use a Tcl command to show multiple configuration parameters: -.Bd -ragged -offset 12345678 -trafficserver> foreach i {http proxy socks ssl} {show:$i} -.Ed -.sp -.Sh SEE ALSO -.Xr traffic_line 1 , -.Xr Tcl n .
