TS-1929: Merge branch 'sphinx-docs'
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/f697d0db Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/f697d0db Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/f697d0db Branch: refs/heads/3.3.x Commit: f697d0dbc7f9a11d810e15cff599b328ca8b0054 Parents: 7d9aaf9 28041ad Author: James Peach <[email protected]> Authored: Thu May 30 19:45:38 2013 -0700 Committer: James Peach <[email protected]> Committed: Thu May 30 19:45:38 2013 -0700 ---------------------------------------------------------------------- doc/Doxyfile.in | 6 +- doc/Makefile.am | 97 + doc/source/_static/images/admin/alarm.jpg | Bin 0 -> 95132 bytes .../_static/images/admin/ats-basic-traffic.png | Bin 0 -> 31464 bytes .../_static/images/admin/ats-traffic-bridge.png | Bin 0 -> 22915 bytes doc/source/_static/images/admin/cache_hit.jpg | Bin 0 -> 79909 bytes doc/source/_static/images/admin/cache_miss.jpg | Bin 0 -> 108282 bytes doc/source/_static/images/admin/cachehrc.jpg | Bin 0 -> 76254 bytes doc/source/_static/images/admin/configur.jpg | Bin 0 -> 102958 bytes doc/source/_static/images/admin/dash.jpg | Bin 0 -> 111902 bytes doc/source/_static/images/admin/dash3.jpg | Bin 0 -> 105424 bytes doc/source/_static/images/admin/firewall.jpg | Bin 0 -> 54553 bytes doc/source/_static/images/admin/httprvs.jpg | Bin 0 -> 78185 bytes doc/source/_static/images/admin/logcolat.jpg | Bin 0 -> 112020 bytes doc/source/_static/images/admin/monitor.jpg | Bin 0 -> 95403 bytes .../images/admin/netscape_common_format.jpg | Bin 0 -> 29378 bytes .../images/admin/netscape_extended2_format.jpg | Bin 0 -> 42918 bytes .../images/admin/netscape_extended_format.jpg | Bin 0 -> 37438 bytes doc/source/_static/images/admin/process.jpg | Bin 0 -> 136229 bytes doc/source/_static/images/admin/records.jpg | Bin 0 -> 166227 bytes doc/source/_static/images/admin/revproxy.jpg | Bin 0 -> 141814 bytes doc/source/_static/images/admin/squid_format.jpg | Bin 0 -> 30949 bytes doc/source/_static/images/admin/ssl_c.jpg | Bin 0 -> 71033 bytes doc/source/_static/images/admin/ssl_os.jpg | Bin 0 -> 75656 bytes doc/source/_static/images/admin/stat.jpg | Bin 0 -> 48740 bytes .../_static/images/admin/summary-mixt.log_file.jpg | Bin 0 -> 32797 bytes .../_static/images/admin/wccp-shared-outer.png | Bin 0 -> 54957 bytes doc/source/_static/images/companies/akamai.png | Bin 0 -> 7655 bytes doc/source/_static/images/companies/betfair.png | Bin 0 -> 4329 bytes doc/source/_static/images/companies/brainswear.png | Bin 0 -> 6452 bytes doc/source/_static/images/companies/comcast.png | Bin 0 -> 5504 bytes doc/source/_static/images/companies/devaus.png | Bin 0 -> 3545 bytes doc/source/_static/images/companies/frisch.png | Bin 0 -> 7873 bytes doc/source/_static/images/companies/godaddy.png | Bin 0 -> 9593 bytes doc/source/_static/images/companies/guruve.png | Bin 0 -> 3124 bytes doc/source/_static/images/companies/internode.png | Bin 0 -> 8323 bytes doc/source/_static/images/companies/linkedin.png | Bin 0 -> 7665 bytes doc/source/_static/images/companies/omniti.png | Bin 0 -> 5032 bytes doc/source/_static/images/companies/powerhttp.png | Bin 0 -> 5340 bytes doc/source/_static/images/companies/sic.png | Bin 0 -> 9999 bytes doc/source/_static/images/companies/suomen.png | Bin 0 -> 7851 bytes doc/source/_static/images/companies/taobao.png | Bin 0 -> 7951 bytes doc/source/_static/images/companies/vng.png | Bin 0 -> 4258 bytes doc/source/_static/images/companies/yahoo.png | Bin 0 -> 5014 bytes doc/source/_static/images/docbook/caution.png | Bin 0 -> 1250 bytes doc/source/_static/images/docbook/important.png | Bin 0 -> 722 bytes doc/source/_static/images/docbook/note.png | Bin 0 -> 490 bytes doc/source/_static/images/docbook/tip.png | Bin 0 -> 449 bytes doc/source/_static/images/docbook/ts75.png | Bin 0 -> 9520 bytes doc/source/_static/images/download_background.png | Bin 0 -> 290 bytes doc/source/_static/images/download_ts.png | Bin 0 -> 4560 bytes doc/source/_static/images/grey_paper.jpg | Bin 0 -> 7290 bytes doc/source/_static/images/press/trafficserver.svg | 164 + .../_static/images/press/ts_logo_tm_1024x196.png | Bin 0 -> 21235 bytes .../_static/images/press/ts_logo_tm_1960x375.png | Bin 0 -> 41128 bytes .../_static/images/press/ts_logo_tm_380x73.png | Bin 0 -> 7500 bytes doc/source/_static/images/press/tsicon.png | Bin 0 -> 4328 bytes doc/source/_static/images/press/tsicon_large.png | Bin 0 -> 8307 bytes doc/source/_static/images/press/tsicon_small.png | Bin 0 -> 2132 bytes .../_static/images/sdk/Protocol_state_diagram.jpg | Bin 0 -> 62342 bytes doc/source/_static/images/sdk/Uses.jpg | Bin 0 -> 96105 bytes doc/source/_static/images/sdk/blacklist75.jpg | Bin 0 -> 93834 bytes doc/source/_static/images/sdk/event_sys80.jpg | Bin 0 -> 70729 bytes doc/source/_static/images/sdk/evt_plugin120.jpg | Bin 0 -> 82354 bytes .../_static/images/sdk/http_header_struct.jpg | Bin 0 -> 41668 bytes doc/source/_static/images/sdk/http_headers.jpg | Bin 0 -> 83292 bytes doc/source/_static/images/sdk/http_state2.jpg | Bin 0 -> 147802 bytes doc/source/_static/images/sdk/marshall_buffers.jpg | Bin 0 -> 90358 bytes doc/source/_static/images/sdk/plugin_process.jpg | Bin 0 -> 34531 bytes doc/source/_static/images/sdk/protocol_evt.jpg | Bin 0 -> 61809 bytes doc/source/_static/images/sdk/protocol_sm_big.jpg | Bin 0 -> 59301 bytes doc/source/_static/images/sdk/transact75.jpg | Bin 0 -> 49702 bytes doc/source/_static/images/sdk/transact_hook75.jpg | Bin 0 -> 84733 bytes doc/source/_static/images/sdk/txn_sm.jpg | Bin 0 -> 94051 bytes doc/source/_static/images/sdk/vconn_buf_output.jpg | Bin 0 -> 44215 bytes doc/source/_static/images/sdk/vconn_buffer.jpg | Bin 0 -> 64914 bytes doc/source/_static/images/sdk/vconnection.jpg | Bin 0 -> 50918 bytes doc/source/_static/images/sdk/vconnection1.jpg | Bin 0 -> 81340 bytes doc/source/_static/images/sdk/vconnection2.jpg | Bin 0 -> 57055 bytes doc/source/_static/images/trans_logo_148x132.png | Bin 0 -> 2356 bytes doc/source/_static/images/trans_logo_150x30.gif | Bin 0 -> 1514 bytes doc/source/_static/images/trans_logo_150x30.png | Bin 0 -> 1285 bytes doc/source/_static/images/trans_logo_150x32.png | Bin 0 -> 2080 bytes doc/source/_static/images/trans_logo_160x35.png | Bin 0 -> 2090 bytes doc/source/_static/images/trans_logo_250x49.gif | Bin 0 -> 2287 bytes doc/source/_static/images/trans_logo_250x49.png | Bin 0 -> 2072 bytes doc/source/_static/images/trans_logo_350x69.gif | Bin 0 -> 3180 bytes doc/source/_static/images/trans_logo_350x69.png | Bin 0 -> 2910 bytes doc/source/_static/images/trans_logo_420x95.png | Bin 0 -> 4213 bytes doc/source/_static/images/trans_logo_603x132.png | Bin 0 -> 5665 bytes doc/source/_static/images/trans_logo_tm_380x69.png | Bin 0 -> 4192 bytes doc/source/_static/images/ts75.png | Bin 0 -> 7340 bytes doc/source/_static/images/warning.png | Bin 0 -> 394 bytes doc/source/admin/cluster-howto.en.rst | 170 + doc/source/admin/configuration-files.en.rst | 43 + .../admin/configuration-files/cache.config.en.rst | 133 + .../configuration-files/congestion.config.en.rst | 197 ++ .../configuration-files/hosting.config.en.rst | 101 + .../admin/configuration-files/icp.config.en.rst | 99 + .../configuration-files/ip_allow.config.en.rst | 89 + .../configuration-files/log_hosts.config.en.rst | 68 + .../configuration-files/logs_xml.config.en.rst | 363 +++ .../admin/configuration-files/parent.config.en.rst | 141 + .../admin/configuration-files/plugin.config.en.rst | 48 + .../configuration-files/records.config.en.rst | 2501 +++++++++++++++ .../admin/configuration-files/remap.config.en.rst | 284 ++ .../configuration-files/splitdns.config.en.rst | 124 + .../ssl_multicert.config.en.rst | 78 + .../configuration-files/storage.config.en.rst | 135 + .../admin/configuration-files/update.config.en.rst | 200 ++ .../admin/configuration-files/volume.config.en.rst | 72 + doc/source/admin/configuring-cache.en.rst | 365 +++ doc/source/admin/configuring-traffic-server.en.rst | 88 + doc/source/admin/event-logging-formats.en.rst | 364 +++ doc/source/admin/explicit-proxy-caching.en.rst | 93 + doc/source/admin/faqs.en.rst | 408 +++ doc/source/admin/forward-proxy.en.rst | 90 + doc/source/admin/getting-started.en.rst | 206 ++ doc/source/admin/hierachical-caching.en.rst | 188 ++ doc/source/admin/http-proxy-caching.en.rst | 793 +++++ doc/source/admin/index.en.rst | 314 ++ doc/source/admin/monitoring-traffic.en.rst | 110 + doc/source/admin/plugins.en.rst | 81 + doc/source/admin/plugins/balancer.en.rst | 92 + doc/source/admin/plugins/buffer_upload.en.rst | 89 + doc/source/admin/plugins/cacheurl.en.rst | 58 + doc/source/admin/plugins/combo_handler.en.rst | 74 + doc/source/admin/plugins/esi.en.rst | 22 + doc/source/admin/plugins/geoip_acl.en.rst | 111 + doc/source/admin/plugins/gzip.en.rst | 98 + doc/source/admin/plugins/header_filter.en.rst | 143 + doc/source/admin/plugins/hipes.en.rst | 64 + doc/source/admin/plugins/mysql_remap.en.rst | 93 + doc/source/admin/plugins/regex_remap.en.rst | 162 + .../admin/plugins/stale_while_revalidate.en.rst | 21 + doc/source/admin/plugins/stats_over_http.en.rst | 37 + .../admin/reverse-proxy-http-redirects.en.rst | 329 ++ doc/source/admin/security-options.en.rst | 248 ++ doc/source/admin/traffic-line-commands.en.rst | 763 +++++ .../admin/traffic-server-error-messages.en.rst | 396 +++ doc/source/admin/transparent-proxy.en.rst | 117 + doc/source/admin/transparent-proxy/bridge.en.rst | 204 ++ doc/source/admin/transparent-proxy/build.en.rst | 58 + .../admin/transparent-proxy/router-inline.en.rst | 92 + .../transparent-proxy/wccp-configuration.en.rst | 155 + doc/source/admin/working-log-files.en.rst | 1004 ++++++ .../admin/working-log-files/log-formats.en.rst | 360 +++ doc/source/conf.py | 285 ++ doc/source/index.en.rst | 37 + doc/source/sdk/actions-guide.en.rst | 180 ++ .../sdk/actions-guide/hosts-lookup-api.en.rst | 28 + doc/source/sdk/adding-statistics.en.rst | 72 + .../adding-statistics/coupled-statistics.en.rst | 122 + .../viewing-statistics-using-traffic-line.en.rst | 33 + doc/source/sdk/continuations.en.rst | 135 + .../how-to-activate-continuations.en.rst | 36 + .../continuations/writing-handler-functions.en.rst | 109 + doc/source/sdk/getting-started.en.rst | 249 ++ .../sdk/getting-started/a-simple-plugin.en.rst | 118 + .../sdk/getting-started/naming-conventions.en.rst | 51 + ...plugin-registration-and-version-checking.en.rst | 86 + doc/source/sdk/header-based-plugin-examples.en.rst | 68 + .../basic-authorization-plugin.en.rst | 43 + ...-and-getting-a-handle-to-the-transaction.en.rst | 45 + .../setting-a-transaction-hook.en.rst | 56 + .../working-with-http-headers.en.rst | 98 + .../blacklist-plugin.en.rst | 107 + ...ccessing-the-transaction-being-processed.en.rst | 61 + .../blacklist-plugin/setting-a-global-hook.en.rst | 37 + .../setting-up-a-transaction-hook.en.rst | 81 + .../working-with-http-header-functions.en.rst | 63 + .../sdk/how-to-create-trafficserver-plugins.en.rst | 227 ++ .../roadmap-for-creating-plugins.en.rst | 90 + doc/source/sdk/http-headers.en.rst | 141 + ...uide-to-trafficserver-http-header-system.en.rst | 63 + .../duplicate-mime-fields-are-not-coalesced.en.rst | 30 + ...ways-belong-to-an-associated-mime-header.en.rst | 70 + .../release-marshal-buffer-handles.en.rst | 88 + doc/source/sdk/http-headers/http-headers.en.rst | 172 + doc/source/sdk/http-headers/marshal-buffers.en.rst | 56 + doc/source/sdk/http-headers/mime-headers.en.rst | 437 +++ doc/source/sdk/http-headers/urls.en.rst | 134 + doc/source/sdk/http-hooks-and-transactions.en.rst | 83 + .../adding-hooks.en.rst | 149 + .../http-alternate-selection.en.rst | 192 ++ .../http-sessions.en.rst | 52 + .../http-transactions.en.rst | 205 ++ .../initiate-http-connection.en.rst | 25 + .../intercepting-http-transactions.en.rst | 30 + doc/source/sdk/http-transformation-plugin.en.rst | 159 + .../append-transform-plugin.en.rst | 145 + ...mple-buffered-null-transformation-plugin.en.rst | 213 ++ .../sample-null-transformation-plugin.en.rst | 231 ++ doc/source/sdk/index.en.rst | 63 + doc/source/sdk/io-guide.en.rst | 194 ++ doc/source/sdk/io-guide/guide-to-cache-api.en.rst | 69 + .../sdk/io-guide/guide-to-cache-api/errors.en.rst | 31 + .../sdk/io-guide/guide-to-cache-api/example.en.rst | 76 + .../how-to-do-a-cache-remove.en.rst | 31 + .../how-to-do-a-cache-write.en.rst | 34 + doc/source/sdk/io-guide/io-buffers.en.rst | 52 + doc/source/sdk/io-guide/net-vconnections.en.rst | 31 + doc/source/sdk/io-guide/transformations.en.rst | 182 ++ doc/source/sdk/io-guide/vios.en.rst | 59 + doc/source/sdk/misc-interface-guide.en.rst | 60 + .../misc-interface-guide/memory-allocation.en.rst | 46 + .../misc-interface-guide/thread-functions.en.rst | 34 + .../sdk/misc-interface-guide/tsfopen-family.en.rst | 54 + doc/source/sdk/mutex-guide.en.rst | 411 +++ doc/source/sdk/new-protocol-plugins.en.rst | 359 +++ doc/source/sdk/plugin-configurations.en.rst | 116 + doc/source/sdk/plugin-management.en.rst | 28 + .../guide-to-the-logging-api.en.rst | 103 + ...ng-trafficserver-settings-and-statistics.en.rst | 59 + doc/source/sdk/preface.en.rst | 49 + doc/source/sdk/preface/how-to-use-this-book.en.rst | 132 + .../sdk/preface/typographical-conventions.en.rst | 36 + doc/source/sdk/remap-plugin.en.rst | 75 + .../sdk/remap-plugin/example-query-remap.en.rst | 152 + doc/source/sdk/sample-source-code.en.rst | 309 ++ doc/source/sdk/troubleshooting-tips.en.rst | 57 + .../debugging-memory-leaks.en.rst | 32 + .../unable-to-debug-tags.en.rst | 113 + .../unable-to-load-plugins.en.rst | 36 + .../troubleshooting-tips/using-a-debugger.en.rst | 40 + 225 files changed, 21315 insertions(+), 3 deletions(-) ----------------------------------------------------------------------
