trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jpe...@apache.org
Subject [4/7] docs: split reference material into top-level pages
Date Thu, 01 Aug 2013 00:05:08 GMT
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/api/TSHttpParserCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpParserCreate.en.rst b/doc/reference/api/TSHttpParserCreate.en.rst
new file mode 100644
index 0000000..faa0a70
--- /dev/null
+++ b/doc/reference/api/TSHttpParserCreate.en.rst
@@ -0,0 +1,91 @@
+.. 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.
+
+.. default-domain:: c
+
+===================
+TSHttpParserCreate
+===================
+
+Library
+=======
+
+Apache Traffic Server plugin API
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSHttpParser TSHttpParserCreate(void)
+.. function:: void TSHttpParserClear(TSHttpParser parser)
+.. function:: void TSHttpParserDestroy(TSHttpParser parser)
+.. function:: TSParseResult TSHttpHdrParseReq(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)
+.. function:: TSParseResult TSHttpHdrParseResp(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)
+
+Description
+===========
+
+:func:`TSHttpParserCreate` creates an HTTP parser object. The
+parser's data structure contains information about the header being
+parsed. A single HTTP parser can be used multiple times, though not
+simultaneously. Before being used again, the parser must be cleared
+by calling :func:`TSHttpParserClear`.
+
+:func:`TSHttpHdrParseReq` parses an HTTP request header. The HTTP
+header :data:`offset` must already be created, and must reside
+inside the marshal buffer :data:`bufp`. The :data:`start` argument
+points to the current position of the string buffer being parsed
+and the :data:`end` argument points to one byte after the end of
+the buffer to be parsed. On return, :data:`start` is modified to
+point past the last character parsed.
+
+It is possible to parse an HTTP request header a single byte at a
+time using repeated calls to :func:`TSHttpHdrParseReq`. As long as
+an error does not occur, the :func:`TSHttpHdrParseReq` function
+will consume that single byte and ask for more. :func:`TSHttpHdrParseReq`
+should be called after :data:`TS_HTTP_READ_REQUEST_HDR_HOOK`.
+
+:func:`TSHttpHdrParseResp` operates in the same manner as
+:func:`TSHttpHdrParseReq` except it parses an HTTP response header.
+It should be called after :data:`TS_HTTP_READ_RESPONSE_HDR_HOOK`.
+
+:func:`TSHttpParserClear` clears the specified HTTP parser so it
+may be used again.
+
+:func:`TSHttpParserDestroy` destroys the TSHttpParser object pointed
+to by :data:`parser`. The :data:`parser` pointer must not be NULL.
+
+Return values
+=============
+
+:func:`TSHttpHdrParseReq` and :func:`TSHttpHdrParseResp` both return
+a :type:`TSParseResult` value. :data:`TS_PARSE_ERROR` is returned
+on error, :data:`TS_PARSE_CONT` is returned if parsing of the header
+stopped because the end of the buffer was reached, and
+:data:`TS_PARSE_DONE` or :data:`TS_PARSE_OK` when a \\r\\n\\r\\n
+pattern is encountered, indicating the end of the header.
+
+Bugs
+====
+
+The distinction between the :data:`TS_PARSE_DONE` and :data:`TS_PARSE_OK`
+results is not well-defined. Plugins should expect both status codes and
+treat them equivalently.
+
+See also
+========
+:manpage:`TSAPI(3ts)`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnMilestoneGet.en.rst b/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
new file mode 100644
index 0000000..993d712
--- /dev/null
+++ b/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
@@ -0,0 +1,76 @@
+.. 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
+
+.. default-domain:: c
+
+=====================
+TSHttpTxnMilestoneGet
+=====================
+
+LIBRARY
+=======
+
+Apache Traffic Server plugin API
+
+SYNOPSIS
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnMilestoneGet(TSHttpTxn txnp, TSMilestonesType milestone, TSHRTime * time)
+
+DESCRIPTION
+===========
+
+:func:`TSHttpTxnMilestoneGet` will fetch a specific milestone timer
+value for the current request. These timers are calculated during
+the lifetime of a transaction, and are all in :type:`TSHRTime` units
+(nanoseconds), measured from the beginning of the transaction. The
+:data:`time` argument is a pointer to a valid :type:`TSHRtime`
+storage, and is set upon success.
+
+The supported :type:`TSMilestonesType` milestone types are:
+
+|
+|
+| :data:`TS_MILESTONE_UA_BEGIN`
+| :data:`TS_MILESTONE_UA_READ_HEADER_DONE`
+| :data:`TS_MILESTONE_UA_BEGIN_WRITE`
+| :data:`TS_MILESTONE_UA_CLOSE`
+| :data:`TS_MILESTONE_SERVER_FIRST_CONNECT`
+| :data:`TS_MILESTONE_SERVER_CONNECT`
+| :data:`TS_MILESTONE_SERVER_CONNECT_END`
+| :data:`TS_MILESTONE_SERVER_BEGIN_WRITE`
+| :data:`TS_MILESTONE_SERVER_FIRST_READ`
+| :data:`TS_MILESTONE_SERVER_READ_HEADER_DONE`
+| :data:`TS_MILESTONE_SERVER_CLOSE`
+| :data:`TS_MILESTONE_CACHE_OPEN_READ_BEGIN`
+| :data:`TS_MILESTONE_CACHE_OPEN_READ_END`
+| :data:`TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN`
+| :data:`TS_MILESTONE_CACHE_OPEN_WRITE_END`
+| :data:`TS_MILESTONE_DNS_LOOKUP_BEGIN`
+| :data:`TS_MILESTONE_DNS_LOOKUP_END`
+| :data:`TS_MILESTONE_SM_START`
+| :data:`TS_MILESTONE_SM_FINISH`
+| :data:`TS_MILESTONE_LAST_ENTRY`
+
+RETURN VALUES
+=============
+
+:data:`TS_SUCCESS` or :data:`TS_ERROR`.
+
+SEE ALSO
+========
+:manpage:`TSAPI(3ts)`

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/api/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/index.en.rst b/doc/reference/api/index.en.rst
new file mode 100644
index 0000000..dcd34b3
--- /dev/null
+++ b/doc/reference/api/index.en.rst
@@ -0,0 +1,28 @@
+API Reference
+*************
+
+.. 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.
+
+.. toctree::
+  :maxdepth: 2
+
+  TSAPI.en
+  TSDebug.en
+  TSHttpHookAdd.en
+  TSHttpParserCreate.en
+  TSHttpTxnMilestoneGet.en

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/index.en.rst b/doc/reference/commands/index.en.rst
new file mode 100644
index 0000000..460f0fc
--- /dev/null
+++ b/doc/reference/commands/index.en.rst
@@ -0,0 +1,35 @@
+.. 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.
+
+Command Reference
+=================
+
+.. toctree::
+  :maxdepth: 1
+
+  traffic_cop.en
+  traffic_line.en
+  traffic_logcat.en
+  traffic_logstats.en
+  traffic_manager.en
+  traffic_server.en
+  traffic_shell.en
+  tspush.en
+  tstop.en
+  tsxs.en
+
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_cop.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_cop.en.rst b/doc/reference/commands/traffic_cop.en.rst
new file mode 100644
index 0000000..366e292
--- /dev/null
+++ b/doc/reference/commands/traffic_cop.en.rst
@@ -0,0 +1,35 @@
+.. 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.
+
+===========
+traffic_cop
+===========
+
+.. program:: traffic_cop
+
+Description
+===========
+
+.. option:: -stop
+
+   Kill children using ``SIGSTOP`` instead of ``SIGKILL``
+
+.. option:: -V
+
+   Print version information and exit.
+
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_line.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_line.en.rst b/doc/reference/commands/traffic_line.en.rst
new file mode 100644
index 0000000..11ad134
--- /dev/null
+++ b/doc/reference/commands/traffic_line.en.rst
@@ -0,0 +1,63 @@
+.. 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.
+
+============
+traffic_line
+============
+
+.. program:: traffic_line
+
+Description
+===========
+
+.. option:: -q, --query_deadhosts
+
+.. option:: -r VAR, --read_var VAR
+
+.. option:: -s VAR, --set_var VAR
+
+.. option:: -v VALUE, --value VALUE
+
+.. option:: -x, --reread_config
+
+.. option:: -M, --restart_cluster
+
+.. option:: -L, --restart_local
+
+.. option:: -S, --shutdown
+
+.. option:: -U, --startup
+
+.. option:: -B, --bounce_cluster
+
+.. option:: -b, --bounce_local
+
+.. option:: -C, --clean_cluster
+
+.. option:: -c, --clear_node
+
+.. option:: -Z, --zero_cluster
+
+.. option:: -z, --zero_node
+
+.. option:: -h, --help
+
+   Print usage information and exit.
+
+.. option:: -V, --version
+
+   Print version information and exit.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_logcat.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_logcat.en.rst b/doc/reference/commands/traffic_logcat.en.rst
new file mode 100644
index 0000000..02f8575
--- /dev/null
+++ b/doc/reference/commands/traffic_logcat.en.rst
@@ -0,0 +1,53 @@
+.. 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.
+
+==============
+traffic_logcat
+==============
+
+.. program:: traffic_logcat
+
+Description
+===========
+
+.. option:: -o PATH, --output_file PATH
+
+.. option:: -a, --auto_filename
+
+.. option:: -f, --follow
+
+.. option:: -C, --clf
+
+.. option:: -E, --elf
+
+.. option:: -S, --squid
+
+.. option:: -2, --elf2
+
+.. option:: -T, --debug_tags
+
+.. option:: -w, --overwrite_output
+
+.. option:: -h, --help
+
+   Print usage information and exit.
+
+.. option:: -V, --version
+
+   Print version information and exit.
+
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_logstats.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_logstats.en.rst b/doc/reference/commands/traffic_logstats.en.rst
new file mode 100644
index 0000000..2f59825
--- /dev/null
+++ b/doc/reference/commands/traffic_logstats.en.rst
@@ -0,0 +1,68 @@
+.. 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.
+
+================
+traffic_logstats
+================
+
+.. program:: traffic_logstats
+
+Description
+===========
+
+.. option:: -f FILE, --log_file FILE
+
+.. option:: -o LIST, --origin_list LIST
+
+.. option:: -O FILE, --origin_file FILE
+
+.. option:: -M COUNT, --max_origins COUNT
+
+.. option:: -u COUNT, --urls COUNT
+
+.. option:: -U COUNT, --show_urls COUNT
+
+.. option:: --A, --as_object
+
+.. option:: -i, --incremental
+
+.. option:: -S FILE, --statetag FILE
+
+.. option:: -t, --tail
+
+.. option:: -s, --summary
+
+.. option:: -j, --json
+
+.. option:: -c, --cgi
+
+.. option:: -m, --min_hits
+
+.. option:: -a, --max_age
+
+.. option:: -l COUNT, --line_len COUNT
+
+.. option:: -T TAGS, --debug_tags TAGS
+
+.. option:: -h, --help
+
+   Print usage information and exit.
+
+.. option:: -V, --version
+
+   Print version information and exit.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_manager.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_manager.en.rst b/doc/reference/commands/traffic_manager.en.rst
new file mode 100644
index 0000000..f602b2a
--- /dev/null
+++ b/doc/reference/commands/traffic_manager.en.rst
@@ -0,0 +1,50 @@
+.. 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.
+
+===============
+traffic_manager
+===============
+
+.. program:: traffic_manager
+
+Description
+===========
+
+.. option:: proxyOff
+.. option:: -nosyslog
+.. option:: -aconfPort PORT
+.. option:: -clusterMCPort PORT
+.. option:: -groupAddr ADDRESS
+.. option:: -clusterRSPort PORT
+.. option:: -debug TAGS
+.. option:: -action TAGS
+.. option:: -path FILE
+.. option:: -recordsConf FILE
+.. option:: -tsArgs ARGUMENTS
+.. option:: -proxyPort PORT
+.. option:: -proxyBackDoor PORT
+.. option:: -schema FILE
+.. option:: -version
+
+Environment
+===========
+
+.. envvar:: MGMT_ACONF_PORT
+.. envvar:: MGMT_CLUSTER_MC_PORT
+.. envvar:: MGMT_CLUSTER_RS_PORT
+.. envvar:: MGMT_GROUP_ADDR
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_server.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_server.en.rst b/doc/reference/commands/traffic_server.en.rst
new file mode 100644
index 0000000..ad3aa73
--- /dev/null
+++ b/doc/reference/commands/traffic_server.en.rst
@@ -0,0 +1,82 @@
+.. 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.
+
+==============
+traffic_server
+==============
+
+.. program:: traffic_server
+
+Description
+===========
+
+.. option:: -n COUNT, --net_threads COUNT
+
+.. option:: -Z COUNT, --cluster_threads COUNT
+
+.. option:: -U COUNT, --udp_threads COUNT
+
+.. option:: -a, --accepts_thread
+
+.. option:: -b, --accept_till_done
+
+.. option:: -p PORT, --httpport PORT
+
+.. option:: -P PORT, --cluster_port PORT
+
+.. option:: -o LEVEL, --dprintf_level LEVEL
+
+.. option:: -R LEVEL, --regression LEVEL
+
+.. option:: -r TEST, --regression_rest TEST
+
+.. option:: -T TAGS, --debug_tags TAGS
+
+.. option:: -B TAGS, --action_tags TAGS
+
+.. option:: -i COUNT, --interval COUNT
+
+.. option:: -M, --remote_management
+
+.. option:: -d DIR, --management_dir DIR
+
+.. option:: -C CMD, --command CMD
+
+.. option:: -k, --clear_hostdb
+
+.. option:: -K, --clear_cache
+
+.. option:: -c CORE, --read_core CORE
+
+.. option:: --accept_mss MSS
+
+.. option:: -t SECS, --poll_timeout SECS
+
+.. option:: -h, --help
+
+   Print usage information and exit.
+
+.. option:: -V, --version
+
+   Print version information and exit.
+
+Environment
+===========
+
+.. envvar:: PROXY_REMOTE_MGMT
+
+.. envvar:: PROXY_AUTO_EXIT

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_shell.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_shell.en.rst b/doc/reference/commands/traffic_shell.en.rst
new file mode 100644
index 0000000..7a56fd0
--- /dev/null
+++ b/doc/reference/commands/traffic_shell.en.rst
@@ -0,0 +1,29 @@
+.. 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.
+
+=============
+traffic_shell
+=============
+
+.. program:: traffic_shell
+
+Description
+===========
+
+.. option:: -V, --version
+
+   Print version information and exit.

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/tspush.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/tspush.en.rst b/doc/reference/commands/tspush.en.rst
new file mode 100644
index 0000000..e32c517
--- /dev/null
+++ b/doc/reference/commands/tspush.en.rst
@@ -0,0 +1,36 @@
+.. 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.
+
+======
+tspush
+======
+
+.. program:: tspush
+
+Description
+===========
+
+.. option:: -f FILE, --file FILE
+
+.. option:: -u URL, --url URL
+
+.. option:: -v, --verbose
+
+.. option:: -h, --help
+
+   Print usage information and exit.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/tstop.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/tstop.en.rst b/doc/reference/commands/tstop.en.rst
new file mode 100644
index 0000000..bf1237d
--- /dev/null
+++ b/doc/reference/commands/tstop.en.rst
@@ -0,0 +1,29 @@
+.. 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.
+
+=====
+tstop
+=====
+
+.. program:: tstop
+
+Description
+===========
+
+.. option:: -s COUNT
+
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/tsxs.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/tsxs.en.rst b/doc/reference/commands/tsxs.en.rst
new file mode 100644
index 0000000..f274e64
--- /dev/null
+++ b/doc/reference/commands/tsxs.en.rst
@@ -0,0 +1,49 @@
+.. 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.
+
+====
+tsxs
+====
+
+.. program:: tsxs
+
+Description
+===========
+
+.. option:: -q VAR, --query VAR
+
+.. option:: -I PATH
+
+.. option:: -L PATH
+
+.. option:: -l LIB
+
+.. option:: -o FILE
+
+.. option:: -i
+
+.. option:: -c FILE [FILE ...]
+
+.. option:: -C FILE [FILE ...]
+
+.. option:: -v, --verbose
+
+.. option:: -h, --help
+
+   Print usage information and exit.
+
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/cache.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/cache.config.en.rst b/doc/reference/configuration/cache.config.en.rst
new file mode 100644
index 0000000..042a048
--- /dev/null
+++ b/doc/reference/configuration/cache.config.en.rst
@@ -0,0 +1,135 @@
+.. 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.
+
+============
+cache.config
+============
+
+.. configfile:: cache.config
+
+The :file:`cache.config` file defines how Traffic Server caches web objects. You
+can add caching rules to specify the following: - Not to cache objects
+from specific IP addresses - How long to pin particular objects in the
+cache - How long to consider cached objects as fresh - Whether to ignore
+no-cache directives from the server
+
+.. important::
+
+    After you modify the :file:`cache.config file`, navigate to
+    the Traffic Server bin directory; then run the :option:`traffic_line -x`
+    command to apply changes. When you apply the changes to a node in a
+    cluster, Traffic Server automatically applies the changes to all other
+    nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`cache.config` file contains a caching rule. Traffic
+Server recognizes three space-delimited tags::
+
+    primary_destination=value secondary_specifier=value action=value
+
+You can use more than one secondary specifier in a rule. However, you
+cannot repeat a secondary specifier. The following list shows the
+possible primary destinations with allowed values.
+
+*``dest_domain``* {#dest_domain}
+    A requested domain name. Traffic Server matches the domain name of
+    the destination from the URL in the request.
+
+*``dest_host``* {#dest_host}
+    A requested hostname. Traffic Server matches the hostname of the
+    destination from the URL in the request.
+
+*``dest_ip``* {#dest_ip}
+    A requested IP address. Traffic Server matches the IP address of the
+    destination in the request.
+
+*``url_regex``* {#url_regex}
+    A regular expression (regex) to be found in a URL.
+
+The secondary specifiers are optional in the :file:`cache.config` file. The
+following list shows possible secondary specifiers with allowed values.
+
+*``port``* {#port}
+    A requested URL port.
+
+*``scheme``* {#scheme}
+    A request URL protocol: http or https.
+
+*``prefix``* {#prefix}
+    A prefix in the path part of a URL.
+
+*``suffix``* {#suffix}
+    A file suffix in the URL.
+
+*``method``* {#method}
+    A request URL method: get, put, post, trace.
+
+*``time``* {#time}
+    A time range, such as 08:00-14:00.
+
+*``src_ip``* {#src_ip}
+    A client IP address.
+
+The following list shows possible actions and their allowed values.
+
+*``action``* {#action}
+    One of the following values:
+
+    -  ``never-cache`` configures Traffic Server to never cache
+       specified objects.
+    -  ``ignore-no-cache`` configures Traffic Server to ignore all
+       ``Cache-Control: no-cache`` headers.
+    -  ``ignore-client-no-cache`` configures Traffic Server to ignore
+       ``Cache-Control: no-cache`` headers from client requests.
+    -  ``ignore-server-no-cache`` configures Traffic Server to ignore
+       ``Cache-Control: no-cache`` headers from origin server responses.
+
+*``pin-in-cache``* {#pin-in-cache}
+    The amount of time you want to keep the object(s) in the cache. The
+    following time formats are allowed:
+
+    -  ``d`` for days; for example: 2d
+    -  ``h`` for hours; for example: 10h
+    -  ``m`` for minutes; for example: 5m
+    -  ``s`` for seconds; for example: 20s
+    -  mixed units; for example: 1h15m20s
+
+*``revalidate``* {#revalidate}
+    The amount of time object(s) are to be considered fresh. Use the
+    same time formats as ``pin-in-cache``.
+
+*``ttl-in-cache``* {#ttl-in-cache}
+    The amount of time object(s) are to be kept in the cache, regardless
+    of Cache-Control response headers. Use the same time formats as
+    pin-in-cache and revalidate .
+
+Examples
+========
+
+The following example configures Traffic Server to revalidate ``gif``
+and ``jpeg`` objects in the domain ``mydomain.com`` every 6 hours, and
+all other objects in ``mydomain.com`` every hour. The rules are applied
+in the order listed.
+
+::
+
+    dest_domain=mydomain.com suffix=gif revalidate=6h
+    dest_domain=mydomain.com suffix=jpeg revalidate=6h
+    dest_domain=mydomain.com revalidate=1h
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/congestion.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/congestion.config.en.rst b/doc/reference/configuration/congestion.config.en.rst
new file mode 100644
index 0000000..391ca0f
--- /dev/null
+++ b/doc/reference/configuration/congestion.config.en.rst
@@ -0,0 +1,197 @@
+.. 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.
+
+=================
+congestion.config
+=================
+
+.. configfile:: congestion.config
+
+The :file:`congestion.config` file enables you to configure Traffic Server
+to stop forwarding HTTP requests to origin servers when they become
+congested, and then send the client a message to retry the congested
+origin server later. After you modify the :file:`congestion.config` file,
+navigate to the Traffic Server bin directory; then run the
+:option:`traffic_line -x` command to apply changes. When you apply the changes
+to a node in a cluster, Traffic Server automatically applies the changes
+to all other nodes in the cluster. Traffic Server uses the
+:file:`congestion.config` file only if you enable the `Congestion
+Control <http#UsingCongestionControl>`_ option.
+
+You can create rules in the congestion.config file to specify:
+
+-  Which origin servers Traffic Server tracks for congestion.
+-  The timeouts Traffic Server uses, depending on whether a server is
+   congested.
+-  The page Traffic Server sends to the client when a server becomes
+   congested.
+-  If Traffic Server tracks the origin servers per IP address or per
+   hostname.
+
+Format
+======
+
+Each line in :file:`congestion.config` must follow the format below. Traffic
+Server applies the rules in the order listed, starting at the top of the
+file. Traffic Server recognizes three space-delimited tags::
+
+    primary_destination=value secondary_specifier=value action=value
+
+The following list shows possible primary destinations with allowed
+values.
+
+*``dest_domain``* {#dest_domain}
+    A requested domain name.
+
+*``dest_host``* {#dest_host}
+    A requested hostname.
+
+*``dest_ip``* {#dest_ip}
+    A requested IP address.
+
+*``url_regex``* {#url_regex}
+    A regular expression (regex) to be found in a URL.
+
+The secondary specifiers are optional in the congestion.config file. The
+following list shows possible secondary specifiers with allowed values.
+You can use more than one secondary specifier in a rule; however, you
+cannot repeat a secondary specifier.
+
+*``port``* {#port}
+    A requested URL port or range of ports.
+
+*``prefix``* {#prefix}
+    A prefix in the path part of a URL.
+
+The following list shows the possible tags and their allowed values.
+
+*``max_connection_failures``* {#max_connection_failures}
+    Default: ``5``
+    The maximum number of connection failures allowed within the fail
+    window described below before Traffic Server marks the origin server
+    as congested.
+
+*``fail_window``* {#fail_window}
+    Default: ``120`` seconds.
+    The time period during which the maximum number of connection
+    failures can occur before Traffic Server marks the origin server as
+    congested.
+
+*``proxy_retry_interval``* {#proxy_retry_interval}
+    Default: ``10`` seconds.
+    The number of seconds that Traffic Server waits before contacting a
+    congested origin server again.
+
+*``client_wait_interval``* {#client_wait_interval}
+    Default: ``300`` seconds.
+    The number of seconds that the client is advised to wait before
+    retrying the congested origin server.
+
+*``wait_interval_alpha``* {#wait_interval_alpha}
+    Default: ``30`` seconds
+    The upper limit for a random number that is added to the wait
+    interval.
+
+*``live_os_conn_timeout``* {#live_os_conn_timeout}
+    Default: ``60`` seconds.
+    The connection timeout to the live (uncongested) origin server. If a
+    client stops a request before the timeout occurs, then Traffic
+    Server does not record a connection failure.
+
+*``live_os_conn_retries``* {#live_os_conn_retries}
+    Default: ``2``
+    The maximum number of retries allowed to the live (uncongested)
+    origin server.
+
+*``dead_os_conn_timeout``* {#dead_os_conn_timeout}
+    Default: ``15`` secondsj
+    The connection timeout to the congested origin server.
+
+*``dead_os_conn_retries``* {#dead_os_conn_retries}
+    Default: ``1``
+    The maximum number of retries allowed to the congested origin
+    server.
+
+*``max_connection``* {#max_connection}
+    Default: ``-1``
+    The maximum number of connections allowed from Traffic Server to the
+    origin server.
+
+*``error_page``* {#error_page}
+    Default: ``"congestion#retryAfter"``
+    The error page sent to the client when a server is congested. You
+    must enclose the value in quotes;
+
+*:file:`congestion.config`* {#congestion_scheme}
+    Default: ``"per_ip"``
+    Specifies if Traffic Server applies the rule on a per-host
+    (``"per_host"``) or per-IP basis (``"per_ip"``). You must enclose
+    the value in quotes.
+
+    For example: if the server ``www.host1.com`` has two IP addresses
+    and you use the tag value ``"per_ip"``, then each IP address has its
+    own number of connection failures and is marked as congested
+    independently. If you use the tag value ``"per_host"`` and the
+    server ``www.host1.com`` is marked as congested, then both IP
+    addresses are marked as congested.
+
+Examples
+========
+
+The following :file:`congestion.config` rule configures Traffic Server to
+stop forwarding requests to the server ``www.host.com`` on port 80 (HTTP
+traffic) if the server is congested, according to the timeouts
+specified. Traffic Server uses the default tag values because no tag has
+been specified.
+
+::
+
+    dest_host=www.host.com port=80
+
+You can use one or more tags in a rule, but each tag must have one value
+only. If you specify no tags in the rule, then Traffic Server uses the
+default values.
+
+You can override any of the default tag values by adding configuration
+variables at the end of :file:`records.config` as follows:
+
+::
+
+    CONFIG proxy.config.http.congestion_control.default.tag INT|STRING value
+
+where tag is one of the tags described in the list under
+:file:`congestion.config` and value is the value you
+want to use.
+
+For example::
+
+    CONFIG proxy.config.http.congestion_control.default.congestion_scheme STRING per_host
+
+.. important::
+
+    Rules in the :file:`congestion.config` file override the
+    following variables in the :file:`records.config` file:
+
+::
+
+    proxy.config.http.connect_attempts_max_retries
+    proxy.config.http.connect_attempts_max_retries_dead_server
+    proxy.config.http.connect_attempts_rr_retries
+    proxy.config.http.connect_attempts_timeout
+    proxy.config.http.down_server.cache_time
+    proxy.config.http.down_server.abort_threshold
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/hosting.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/hosting.config.en.rst b/doc/reference/configuration/hosting.config.en.rst
new file mode 100644
index 0000000..73cae87
--- /dev/null
+++ b/doc/reference/configuration/hosting.config.en.rst
@@ -0,0 +1,98 @@
+.. 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.
+
+==============
+hosting.config
+==============
+
+.. configfile:: hosting.config
+
+The :file:`hosting.config` file enables you to assign cache partitions to
+specific origin servers and/or domains so that you can manage cache
+space efficiently and restrict disk usage. For step-by-step instructions
+on partitioning the cache according to origin servers and/or domains,
+refer to `Partitioning the Cache <../configuring-cache#PartitoningCache>`_.
+Before you can assign cache partitions to specific
+origin servers and/or domains, you must first partition your cache
+according to size and protocol in the :file:`volume.config`
+file. For step-by-step instructions about partitioning your cache, refer
+to `Partitioning the Cache <../configuring-cache#PartitioningCache>`_.
+
+After you modify hosting.config, navigate to the Traffic Server bin
+directory and run :option:`traffic_line -x` to apply your changes.
+
+When you apply the changes to a node in a cluster, Traffic Server
+automatically applies the changes to all other nodes in the cluster.
+
+.. important::
+
+    The :file:`volume.config` configuration must be the same on all nodes in a cluster.
+
+Format
+======
+
+Each line in the :file:`hosting.config` file must have one of the following
+formats::
+
+    hostname=HOST partition=NUMBERS
+    domain=DOMAIN partition=NUMBERS
+
+where ``HOST`` is the fully-qualified hostname of the origin server
+whose content you want to store on a particular partition (for example,
+``www.myhost.com``); ``DOMAIN`` is the domain whose content you
+want to store on a particular partition(for example, ``mydomain.com``);
+and ``NUMBERS`` is a comma-separated list of the partitions on
+which you want to store the content that belongs to the origin server or
+domain listed. The partition numbers must be valid numbers listed in the
+file:`volume.config`.
+
+**Note:** To allocate more than one partition to an origin server or
+domain, you must enter the partitions in a comma-separated list on one
+line, as shown in the example below. The
+:file:`hosting.config`  file cannot contain multiple entries
+for the same origin server or domain.
+
+Generic Partition
+=================
+
+When configuring the :file:`hosting.config` file, you must assign a generic
+partition to use for content that does not belong to any of the origin
+servers or domains listed. If all partitions for a particular origin
+server become corrupt, Traffic Server will also use the generic
+partition to store content for that origin server.
+
+The generic partition must have the following format::
+
+    hostname=* partition=NUMBERS
+
+where ``NUMBERS`` is a comma-separated list of generic
+partitions.
+
+Examples
+========
+
+The following example configures Traffic Server to store content from
+the domain ``mydomain.com`` in partition 1 and content from
+``www.myhost.com`` in partition 2. Traffic Server stores content from
+all other origin servers in partitions 3 and 4.
+
+::
+
+    domain=mydomain.com partition=1
+    hostname=www.myhost.com partition=2
+    hostname=* partition=3,4
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/icp.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/icp.config.en.rst b/doc/reference/configuration/icp.config.en.rst
new file mode 100644
index 0000000..877e459
--- /dev/null
+++ b/doc/reference/configuration/icp.config.en.rst
@@ -0,0 +1,104 @@
+.. 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.
+
+==========
+icp.config
+==========
+
+.. configfile:: icp.config
+
+.. warning::
+
+  The Traffic Server ICP  feature is not functional in this release.
+
+The :file:`icp.config` file defines ICP peers (parent and sibling caches).
+
+.. important::
+
+    After you modify the icp.config file, navigate to the
+    Traffic Server bin directory and run the :option:`traffic_line -x` command to
+    apply the changes. When you apply the changes to a node in a cluster,
+    Traffic Server automatically applies the changes to all other nodes in
+    the cluster.
+
+Format
+======
+
+Each line in the icp.config file contains the name and configuration
+information for a single ICP peer in the following format::
+
+    host : host_IP : peer_type : proxy_port : icp_port : MC_on : MC_IP : MC_TTL :
+
+Each field is described in the following list.
+
+*``host``* {#host}
+    The hostname of the ICP peer.
+
+    This field is optional; if you do not specify the hostname of the
+    ICP peer, you must specify the IP address.
+
+*``host_IP``* {#host_IP}
+    The IP address of the ICP peer.
+
+    This field is optional; if you do not specify the IP address of the
+    ICP peer, you must specify the hostname.
+
+*``ctype``* {#ctype}
+    Use the following options:
+
+    -  1 to indicate an ICP parent cache
+    -  2 to indicate an ICP sibling cache
+
+*``proxy_port``* {#proxy_port}
+    The port number of the TCP port used by the ICP peer for proxy
+    communication.
+
+*``icp_port``* {#icp_port}
+    The port number of the UDP port used by the ICP peer for ICP
+    communication.
+
+*``MC_on``* {#mc_on}
+    Enable or disable MultiCast:
+
+    -  0 if multicast is disabled
+    -  1 if multicast is enabled
+
+*``MC_ip``* {#mc_ip}
+    The MultiCast IP address.
+
+*``MC_ttl``* {#mc_ttl}
+    The multicast time to live. Use the following options:
+
+    -  1 if IP multicast datagrams will not be forwarded beyond a single
+       subnetwork
+    -  2 to allow delivery of IP multicast datagrams to more than one
+       subnet (if there are one or more multicast routers attached to
+       the first hop subnet).
+
+Examples
+========
+
+The following example configuration is for three nodes: the local host,
+one parent, and one sibling.
+
+::
+
+    :::text
+    localhost:0.0.0.0:3:8080:3130:0:0.0.0.0:1
+    host1:123.12.1.23:1:8080:3131:0:0.0.0.0:1
+    host2:123.12.1.24:2:8080:3131:0:0.0.0.0:1
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/index.en.rst b/doc/reference/configuration/index.en.rst
new file mode 100644
index 0000000..0487109
--- /dev/null
+++ b/doc/reference/configuration/index.en.rst
@@ -0,0 +1,39 @@
+.. 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.
+
+Configuration File Reference
+============================
+
+.. toctree::
+  :maxdepth: 2
+
+  cache.config.en
+  congestion.config.en
+  hosting.config.en
+  icp.config.en
+  ip_allow.config.en
+  log_hosts.config.en
+  logs_xml.config.en
+  parent.config.en
+  plugin.config.en
+  records.config.en
+  remap.config.en
+  splitdns.config.en
+  ssl_multicert.config.en
+  storage.config.en
+  update.config.en
+  volume.config.en

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/ip_allow.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/ip_allow.config.en.rst b/doc/reference/configuration/ip_allow.config.en.rst
new file mode 100644
index 0000000..49812a1
--- /dev/null
+++ b/doc/reference/configuration/ip_allow.config.en.rst
@@ -0,0 +1,77 @@
+.. 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.
+
+===============
+ip_allow.config
+===============
+
+.. configfile:: ip_allow.config
+
+The :file:`ip_allow.config` file controls client access to the Traffic
+Server proxy cache. You can specify ranges of IP addresses that are
+allowed to use the Traffic Server as a web proxy cache. After you modify
+the :file:`ip_allow.config` file, navigate to the Traffic Server bin
+directory and run the :option:`traffic_line -x` command to apply changes. When
+you apply the changes to a node in a cluster, Traffic Server
+automatically applies the changes to all other nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`ip_allow.config` file must have the following
+format::
+
+    src_ip=<range of IP addresses> action=<action> [method=<list of methods separated by '|'>]
+
+where src_ip is the IP address or range of IP addresses of the
+client(s). The action ``ip_allow`` enables the specified client(s) to
+access the Traffic Server proxy cache, and ``ip_deny`` denies the
+specified client(s) to access the Traffic Server proxy cache. Multiple
+method keywords can be specified (method=GET method=HEAD), or multiple
+methods can be separated by an '\|' (method=GET\|HEAD). The method
+keyword is optional and it is defaulted to ALL. Available methods: ALL,
+GET, CONNECT, DELETE, HEAD, ICP_QUERY, OPTIONS, POST, PURGE, PUT,
+TRACE, PUSH
+
+By default, the :file:`ip_allow.config` file contains the following lines,
+which allows all methods to localhost to access the Traffic Server proxy
+cache and denies PUSH, PURGE and DELETE to all IPs (note this allows all
+other methods to all IPs)::
+
+    src_ip=127.0.0.1                                  action=ip_allow method=ALL
+    src_ip=::1                                        action=ip_allow method=ALL
+    src_ip=0.0.0.0-255.255.255.255                    action=ip_deny  method=PUSH|PURGE|DELETE
+    src_ip=::-ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff action=ip_deny  method=PUSH|PURGE|DELETE
+
+Examples
+========
+
+The following example enables all clients to access the Traffic Server
+proxy cache::
+
+    src_ip=0.0.0.0-255.255.255.255 action=ip_allow
+
+The following example allows all clients on a specific subnet to access
+the Traffic Server proxy cache::
+
+    src_ip=123.12.3.000-123.12.3.123 action=ip_allow
+
+The following example denies all clients on a specific subnet to access
+the Traffic Server proxy cache::
+
+    src_ip=123.45.6.0-123.45.6.123 action=ip_deny
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/log_hosts.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/log_hosts.config.en.rst b/doc/reference/configuration/log_hosts.config.en.rst
new file mode 100644
index 0000000..dcb74e9
--- /dev/null
+++ b/doc/reference/configuration/log_hosts.config.en.rst
@@ -0,0 +1,66 @@
+.. 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.
+
+================
+log_hosts.config
+================
+
+.. configfile:: log_hosts.config
+
+To record HTTP transactions for different origin servers in separate log
+files, you must list each origin server hostname in the
+:file:`log_hosts.config` file. In addition, you must enable the `HTTP Host
+Log Splitting <../working-log-files#HTTPHostLogSplitting>`_ option. You
+should use the same :file:`log_hosts.config` file on every Traffic Server
+node in your cluster. After you modify the :file:`log_hosts.config` file,
+run the :option:`traffic_line -x` command to apply the changes.
+When you apply the changes to a node in a cluster, Traffic Server automatically applies the
+changes to all other nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`log_hosts.config` file has the following format::
+
+    hostname
+
+where ``hostname`` is the hostname of the origin server.
+
+.. hint::
+
+    You can specify keywords in the :file:`log_hosts.config` file to
+    record all transactions from origin servers with the specified keyword
+    in their names in a separate log file. See the example below.
+
+Examples
+========
+
+The following example configures Traffic Server to create separate log
+files containing all HTTP transactions for the origin servers
+``webserver1``, ``webserver2``, and ``webserver3``::
+
+    webserver1
+    webserver2
+    webserver3
+
+The following example records all HTTP transactions from origin servers
+that contain ``sports`` in their names. For example:
+``sports.yahoo.com`` and ``www.foxsports.com`` in a log file called
+``squid-sport.log`` (the Squid format is enabled)::
+
+    sports
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/logs_xml.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/logs_xml.config.en.rst b/doc/reference/configuration/logs_xml.config.en.rst
new file mode 100644
index 0000000..e9ad379
--- /dev/null
+++ b/doc/reference/configuration/logs_xml.config.en.rst
@@ -0,0 +1,370 @@
+.. 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.
+
+===============
+logs_xml.config
+===============
+
+.. configfile:: logs_xml.config
+
+The :file:`logs_xml.config` file defines the custom log file formats,
+filters, and processing options. The format of this file is modeled
+after XML, the Extensible Markup Language.
+
+Format
+======
+
+The :file:`logs_xml.config` file contains the specifications below:
+
+-  ``LogFormat`` specifies the fields to be gathered from each protocol
+   event access.
+-  ``LogFilter`` specifies the filters that are used to include or
+   exclude certain entries being logged based on the value of a field
+   within that entry.
+-  ``LogObject`` specifies an object that contains a particular format,
+   a local filename, filters, and collation servers.
+
+The :file:`logs_xml.config` file ignores extra white space, blank lines, and
+all comments.
+
+LogFormat
+=========
+
+The following list shows ``LogFormat`` specifications.
+
+*``&lt;Name = "valid_format_name"/&gt;``* {#LogsXMLFormatName}
+    Required
+    Valid format names include any name except ``squid``, ``common``,
+    ``extended``, or ``extended2``, which are pre-defined formats. There
+    is no default for this tag.
+
+*``&lt;Format = "valid_format_specification"/&gt;``* {#LogsXMLFormat}
+    Required
+    A valid format specification is a printf-style string describing
+    each log entry when formatted for ASCII output. Use ``%<``
+    *``field``* ``>`` as a placeholder for valid field names. For more
+    information, refer to `Custom Logging
+    Fields <../event-logging-formats#CustomLoggingFields>`_.
+
+    The specified field can be one of the following types:
+
+    Simple. For example: ``%<cqu>``
+    A field within a container, such as an HTTP header or a statistic.
+    Fields of this type have the syntax:
+
+    ::
+
+         %<{ field } container>
+
+    Aggregates, such as ``COUNT``, ``SUM``, ``AVG``, ``FIRST``,
+    ``LAST``. Fields of this type have the syntax: ``%<operator (``
+    *``field``* ``)>``
+
+.. note::
+
+    You cannot create a format specification that contains both aggregate operators and regular fields.
+
+*``&lt;Interval = "aggregate_interval_secs"/&gt;``* {#LogsXMLInterval}
+    Optional
+    Use this tag when the format contains aggregate operators. The value
+    "``aggregate_interval_secs``\ " represents the number of seconds
+    between individual aggregate values being produced.
+
+    The valid set of aggregate operators are:
+
+    -  COUNT
+    -  SUM
+    -  AVG
+    -  FIRST
+    -  LAST
+
+LogFilters
+==========
+
+The following list shows the ``LogFilter`` specifications.
+
+*``&lt;Name = "valid_filter_name"/&gt;``* {#LogsXMLFilterName}
+    Required
+    All filters must be uniquely named.
+
+*``&lt;Condition = "valid_log_field valid_operator valid_comparison_value"/&gt;``*
+{#LogsXMLFilterCondition}
+    Required
+    This field contains the following elements:
+
+    ``valid_log_field`` - the field that will be compared against
+    the given value. For more information, refer to `Logging Format
+    Cross-Reference <../event-logging-formats#LoggingFormatCrossReference>`_.
+
+    ``valid_operator_field`` - any one of the following: ``MATCH``,
+    ``CASE_INSENSITIVE_MATCH``, ``CONTAIN``,
+    ``CASE_INSENSITIVE_CONTAIN``.
+
+    -  ``MATCH`` is true if the field and value are identical
+       (case-sensitive).
+    -  ``CASE_INSENSITIVE_MATCH`` is similar to ``MATCH``, except that
+       it is case-insensitive.
+    -  ``CONTAIN`` is true if the field contains the value (the value is
+       a substring of the field).
+    -  ``CASE_INSENSITIVE_CONTAIN`` is a case-insensitive version of
+       ``CONTAIN``.
+
+    ``valid_comparison_value`` - any string or integer matching the
+    field type. For integer values, all of the operators are equivalent
+    and mean that the field must be equal to the specified value.
+
+.. note::
+
+    There are no negative comparison operators. If you want to
+    specify a negative condition, then use the ``Action`` field to
+    ``REJECT`` the record.
+
+*``&lt;Action = "valid_action_field"/&gt;``* {#LogsXMLFilterAction}
+    Required: ``ACCEPT`` or ``REJECT`` .
+    This instructs Traffic Server to either accept or reject records
+    that satisfy the filter condition.
+
+LogObject
+=========
+
+The following list shows the ``LogObject`` specifications.
+
+*``&lt;Format = "valid_format_name"/&gt;``* {#LogsXMLObjectFormat}
+    Required
+    Valid format names include the predefined logging formats:
+    ``squid``, ``common``, ``extended``, and ``extended2``, as well as
+    any previously-defined custom log formats. There is no default for
+    this tag.
+
+*``&lt;Filename = "file_name"/&gt;``* {#LogsXMLObjectFilename}
+    Required
+    The filename to which the given log file is written on the local
+    file system or on a remote collation server. No local log file will
+    be created if you fail to specify this tag. All filenames are
+    relative to the default logging directory.
+
+    If the name does not contain an extension (for example, ``squid``),
+    then the extension ``.log`` is automatically appended to it for
+    ASCII logs and ``.blog`` for binary logs (refer to `Mode =
+    "valid_logging_mode" <#LogsXMLOjbectMode>`_).
+
+    If you do not want an extension to be added, then end the filename
+    with a single (.) dot (for example: ``squid.`` ).
+
+*``&lt;Mode = "valid_logging_mode"/&gt;``* {#LogsXMLOjbectMode}
+    Optional
+    Valid logging modes include ``ascii`` , ``binary`` , and
+    ``ascii_pipe`` . The default is ``ascii`` .
+
+    -  Use ``ascii`` to create event log files in human-readable form
+       (plain ASCII).
+    -  Use ``binary`` to create event log files in binary format. Binary
+       log files generate lower system overhead and occupy less space on
+       the disk (depending on the information being logged). You must
+       use the ``logcat`` utility to translate binary log files to ASCII
+       format before you can read them.
+    -  Use ``ascii_pipe`` to write log entries to a UNIX named pipe (a
+       buffer in memory). Other processes can then read the data using
+       standard I/O functions. The advantage of using this option is
+       that Traffic Server does not have to write to disk, which frees
+       disk space and bandwidth for other tasks. In addition, writing to
+       a pipe does not stop when logging space is exhausted because the
+       pipe does not use disk space.
+
+    If you are using a collation server, then the log is written to a
+    pipe on the collation server. A local pipe is created even before a
+    transaction is processed, so you can see the pipe right after
+    Traffic Server starts. Pipes on a collation server, however, *are*
+    created when Traffic Server starts.
+
+*``&lt;Filters = "list_of_valid_filter_names"/&gt;``*
+{#LogsXMLObjectFilters}
+    Optional
+    A comma-separated list of names of any previously-defined log
+    filters. If more than one filter is specified, then all filters must
+    accept a record for the record to be logged.
+
+*``&lt;Protocols = "list_of_valid_protocols"/&gt;``*
+{#LogsXMLObjectProtocols}
+    Optional
+    A comma-separated list of the protocols this object should log.
+    Valid protocol names for this release are ``HTTP`` (FTP is
+    deprecated).
+
+*``&lt;ServerHosts = "list_of_valid_servers"/&gt;``*
+{#LogsXMLObjectServerHosts}
+    Optional
+    A comma-separated list of valid hostnames.This tag indicates that
+    only entries from the named servers will be included in the file.
+
+*``&lt;CollationHosts = "list_of_valid_hostnames"/&gt;``*
+{#LogsXMLObjectCollationHosts}
+    Optional
+    A comma-separated list of collation servers to which all log entries
+    (for this object) are forwarded. Collation servers can be specified
+    by name or IP address. Specify the collation port with a colon after
+    the name; for example, ``host:port`` .
+
+*``&lt;Header = "header"/&gt;``* {#LogsXMLObjectHeader}
+    Optional
+    The header text you want the log files to contain. The header text
+    appears at the beginning of the log file, just before the first
+    record.
+
+*``&lt;RollingEnabled = "truth value"/&gt;``*
+{#LogsXMLObjectRollingEnabled}
+    Optional
+    Enables or disables log file rolling for the ``LogObject``. This
+    setting overrides the value for the
+    *``proxy.config.log.rolling_enabled``* variable in the
+    :file:`records.config` file. Set *``truth value``* to one of the
+    following values:
+
+    -  ``0`` to disable rolling for this particular ``LogObject``.
+    -  ``1`` to roll log files at specific intervals during the day (you
+       specify time intervals with the ``RollingIntervalSec`` and
+       ``RollingOffsetHr`` fields).
+    -  ``2`` to roll log files when they reach a certain size (you
+       specify the size with the\ ``RollingSizeMb`` field).
+    -  ``3`` to roll log files at specific intervals during the day or
+       when they reach a certain size (whichever occurs first).
+    -  ``4`` to roll log files at specific intervals during the day when
+       log files reach a specific size (at a specified time if the file
+       is of the specified size).
+
+*``&lt;RollingIntervalSec = "seconds"/&gt;``*
+{#LogsXMLObjectRollingIntervalSec}
+    Optional
+    The seconds between log file rolling for the ``LogObject``; enables
+    you to specify different rolling intervals for different
+    ``LogObjects``.
+
+    This setting overrides the value for
+    *``proxy.config.log.rolling_interval_sec``* in the
+    :file:`records.config` file.
+
+*``&lt;RollingOffsetHr = "hour"/&gt;``* {#LogsXMLObjectRollingOffsetHr}
+    Optional
+    Specifies an hour (from 0 to 23) at which rolling is guaranteed to
+    align. Rolling might start before then, but a rolled file will be
+    produced only at that time. The impact of this setting is only
+    noticeable if the rolling interval is larger than one hour. This
+    setting overrides the configuration setting for
+    *``proxy.config.log.rolling_offset_hr``* in the :file:`records.config`
+    file.
+
+*``&lt;RollingSizeMb = "size_in_MB"/&gt;``*
+{#LogsXMLObjectRollingSizeMb}
+    Optional
+    The size at which log files are rolled.
+
+Examples
+========
+
+The following is an example of a ``LogFormat`` specification that
+collects information using three common fields:
+
+::
+
+         <LogFormat>
+             <Name="minimal"/>
+             <Format = "%<chi> : %<cqu> : %<pssc>"/>
+         </LogFormat>
+
+The following is an example of a ``LogFormat`` specification that
+uses aggregate operators:
+
+::
+
+         <LogFormat>
+             <Name = "summary"/>
+             <Format = "%<LAST(cqts)> : %<COUNT(*)> : %<SUM(psql)>"/>
+             <Interval = "10"/>
+         </LogFormat>
+
+The following is an example of a ``LogFilter`` that will cause only
+``REFRESH_HIT`` entries to be logged:
+
+::
+
+         <LogFilter>
+              <Name = "only_refresh_hits"/>
+              <Action = "ACCEPT"/>
+              <Condition = "%<pssc> MATCH REFRESH_HIT"/>
+         </LogFilter>
+
+.. note:
+
+    When specifying the field in the filter condition, you can
+    omit the\ ``%<>``. This means that the filter below is equivalent to the
+    example directly above:
+
+::
+
+         <LogFilter>
+             <Name = "only_refresh_hits"/>
+             <Action = "ACCEPT"/>
+             <Condition = "pssc MATCH REFRESH_HIT"/>
+         </LogFilter>
+
+The following is an example of a ``LogObject`` specification that
+creates a local log file for the minimal format defined earlier. The log
+filename will be ``minimal.log`` because this is an ASCII log file (the
+default).
+
+::
+
+         <LogObject>
+             <Format = "minimal"/>
+             <Filename = "minimal"/>
+         </LogObject>
+
+The following is an example of a ``LogObject`` specification that
+includes only HTTP requests served by hosts in the domain
+``company.com`` or by the specific server ``server.somewhere.com``. Log
+entries are sent to port 4000 of the collation host ``logs.company.com``
+and to port 5000 of the collation host ``209.131.52.129.``
+
+::
+
+         <LogObject>
+              <Format = "minimal"/>
+              <Filename = "minimal"/>
+              <ServerHosts = "company.com,server.somewhere.com"/>
+              <Protocols = "http"/>
+              <CollationHosts = "logs.company.com:4000,209.131.52.129:5000"/>
+         </LogObject>
+
+WELF
+====
+
+Traffic Server supports WELF (WebTrends Enhanced Log Format) so you can
+analyze Traffic Server log files with WebTrends reporting tools. A
+predefined ``<LogFormat>`` that is compatible with WELF is provided in
+the :file:`logs_xml.config` file (shown below). To create a WELF format log
+file, create a ``<LogObject>`` that uses this predefined format.
+
+::
+
+         <LogFormat>
+             <Name = "welf"/>
+             <Format = "id=firewall time=\"%<cqtd> %<cqtt>\" fw=%<phn> pri=6
+                proto=%<cqus> duration=%<ttmsf> sent=%<psql> rcvd=%<cqhl>
+                src=%<chi> dst=%<shi> dstname=%<shn> user=%<caun> op=%<cqhm>
+                arg=\"%<cqup>\" result=%<pssc> ref=\"%<{Referer}cqh>\"
+                agent=\"%<{user-agent}cqh>\" cache=%<crc>"/>
+         </LogFormat>

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/parent.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/parent.config.en.rst b/doc/reference/configuration/parent.config.en.rst
new file mode 100644
index 0000000..1391c7c
--- /dev/null
+++ b/doc/reference/configuration/parent.config.en.rst
@@ -0,0 +1,139 @@
+.. 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.
+
+=============
+parent.config
+=============
+
+.. configfile:: parent.config
+
+The :file:`parent.config` file identifies the parent proxies used in an
+cache hierarchy. Use this file to perform the following configuration:
+
+-  Set up parent cache hierarchies, with multiple parents and parent
+   failover
+-  Configure selected URL requests to bypass parent proxies
+
+Traffic Server uses the :file:`parent.config` file only when the parent
+caching option is enabled (refer to `Configuring Traffic Server to Use a
+Parent Cache <../hierachical-caching>`_).
+
+After you modify the :file:`parent.config` file, run the :option:`traffic_line -x`
+command to apply your changes. When you apply the changes to one node in
+a cluster, Traffic Server automatically applies the changes to all other
+nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`parent.config` file must contain a parent caching
+rule. Traffic Server recognizes three space-delimited tags:
+
+    primary_destination=value secondary_specifier=value  action=value
+
+The following list shows the possible primary destinations and their
+allowed values.
+
+*``dest_domain``* {#dest_domain}
+    A requested domain name.
+
+*``dest_host``* {#dest_host}
+    A requested hostname.
+
+*``dest_ip``* {#dest_ip}
+    A requested IP address or range of IP addresses separated by a dash
+    (-).
+
+*``url_regex``* {#url_regex}
+    A regular expression (regex) to be found in a URL
+
+The secondary specifiers are optional in the :file:`parent.config` file. The
+following list shows the possible secondary specifiers and their allowed
+values.
+
+*``port``* {#port}
+    A requested URL port.
+
+*``scheme``* {#scheme}
+    A request URL protocol: ``http`` or ``https``.
+
+*``prefix``* {#prefix}
+    A prefix in the path part of a URL.
+
+*``suffix``* {#suffix}
+    A file suffix in the URL.
+
+*``method``* {#method}
+    A request URL method. It can be one of the following:
+
+    -  get
+    -  post
+    -  put
+    -  trace
+
+*``time``* {#time}
+    A time range, such as 08:00-14:00, during which the parent cache is
+    used to serve requests.
+
+*``src_ip``* {#src_ip}
+    A client IP address.
+
+The following list shows the possible actions and their allowed values.
+
+``parent``
+    An ordered list of parent servers. If the request cannot be handled
+    by the last parent server in the list, then it will be routed to the
+    origin server. You can specify either a hostname or an IP address,
+    but; you must specify the port number.
+
+``round_robin``
+    One of the following values:
+
+    -  ``true`` - Traffic Server goes through the parent cache list in a
+       round robin-based on client IP address.
+    -  ``strict`` - Traffic Server machines serve requests strictly in
+       turn. For example: machine ``proxy1`` serves the first request,
+       ``proxy2`` serves the second request, and so on.
+    -  ``false`` - Round robin selection does not occur.
+
+``go_direct``
+    One of the following values:
+
+    -  ``true`` - requests bypass parent hierarchies and go directly to
+       the origin server.
+    -  ``false`` - requests do not bypass parent hierarchies.
+
+Examples
+========
+
+The following rule configures a parent cache hierarchy consisting of
+Traffic Server (which is the child) and two parents, ``p1.x.com`` and
+``p2.x.com``. Traffic Server forwards the requests it cannot serve to
+the parent servers ``p1.x.com`` and ``p2.x.com`` in a round-robin
+fashion::
+
+    round_robin=true
+    dest_domain=. method=get parent="p1.x.com:8080; p2.y.com:8080" round_robin=true
+
+The following rule configures Traffic Server to route all requests
+containing the regular expression ``politics`` and the path
+``/viewpoint`` directly to the origin server (bypassing any parent
+hierarchies): ``url_regex=politics prefix=/viewpoint go_direct=true``
+
+Every line in the :file:`parent.config` file must contain either a
+``parent=`` or ``go_direct=`` directive.
+

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/plugin.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/plugin.config.en.rst b/doc/reference/configuration/plugin.config.en.rst
new file mode 100644
index 0000000..9a5afa6
--- /dev/null
+++ b/doc/reference/configuration/plugin.config.en.rst
@@ -0,0 +1,51 @@
+.. 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.
+
+=============
+plugin.config
+=============
+
+.. configfile:: plugin.config
+
+The :file:`plugin.config` file controls run-time loadable plugins available
+to the Traffic Server, as well as their configuration.
+
+Example
+=======
+
+::
+
+     # Comments start with a '#' and continue to the end of the line
+     # Blank lines are ignored
+     #
+     # test-plugin.so arg1 arg2 arg3
+     #
+     plugins/iwx/iwx.so
+     plugins/abuse/abuse.so etc/trafficserver/abuse.config
+     plugins/icx/icx.so etc/trafficserver/icx.config
+
+Each configuration line consists of a path to an ``.so`` file. This path
+can either be absolute, or relative to the plugin-directory (usually
+``/usr/local/libexec/trafficserver``). Such a line tells Traffic Server
+to load said plugin.
+
+A plugin can have any number of configuration parameters listed. Please
+refer to our `plugins' documentation <../plugins>`_ for their reference.
+
+Plugins should only be listed *once*. The order in which the plugins are
+listed is also the order in which they are chained for the processing.
+


Mime
View raw message