[
https://issues.apache.org/jira/browse/TS-764?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13030530#comment-13030530
]
Leif Hedstrom commented on TS-764:
----------------------------------
First, there's an extensive administrators guide available, see
http://trafficserver.apache.org/docs.html . Granted, this is not entirely up to
do, but there's a huge effort being made right now by Igor Galic and Alan to
get this migrated to the Apache CMS. I'm sure they would welcome more help here.
1) Yes, man pages would be good for traffic_server, traffic_cop and
traffic_manager. There is a "man" page directory in doc/man.
2) Both traffic_server and traffic_manager provides such a help option. e.g.
{code}
root@loki 294/0 # ./bin/traffic_server -h
[TrafficServer] using root directory '/opt/ats'
Usage: ./bin/traffic_server [--SWITCH [ARG]]
switch__________________type__default___description
-l, --lock_memory int 0 Lock process in memory (must be root)
-n, --net_threads int 8 Number of Net Threads
-Z, --cluster_threads int 1 Number of Cluster Threads
-U, --udp_threads int 1 Number of UDP Threads
-a, --accept_thread tog false Use an Accept Thread
-b, --accept_till_done tog true Accept Till Done
-p, --httpport int 0 Port Number for HTTP Accept
-A, --acceptfds str (null) File Descriptor List for Accept
-P, --cluster_port int 0 Cluster Port Number
-o, --dprintf_level int 0 Debug output level
-V, --version tog false Print Version String
-T, --debug_tags str (null) Vertical-bar-separated Debug Tags
-B, --action_tags str (null) Vertical-bar-separated Behavior Tags
-i, --interval int 0 Statistics Interval
-M, --remote_management tog false Remote Management
-d, --management_dir str /opt/at.. Management Directory
-C, --command str (null) Maintenance Command to Execute
-k, --clear_hostdb on false Clear HostDB on Startup
-K, --clear_cache on false Clear Cache on Startup
-v, --vingid str (null) Vingid Flag
-c, --read_core str (null) Read Core file
- , --accept_mss int 0 MSS for client connections
-t, --poll_timeout int 10 poll timeout in milliseconds
-h, --help HELP!
{code}
3) The environment is not well tested / supported I think, but yeah, we could
add something in the man page to traffic_server about it (and the real docs as
well).
> Traffic Server does not ship any documentation
> -----------------------------------------------
>
> Key: TS-764
> URL: https://issues.apache.org/jira/browse/TS-764
> Project: Traffic Server
> Issue Type: Improvement
> Components: Packaging
> Affects Versions: 2.1.8
> Reporter: Arno Toell
> Fix For: 3.0
>
>
> A major problem for ATS to the unskilled user as of today is, there is no
> on-line documentation besides the (somewhat scarce) information from the
> home page is available. In particular ATS misses
> * first of all: man pages
> * Description of command line switches (if any), including an interactive
> help, e.g. the common _"-h/--help"_ switch.
> * Description of the used environment, e.g. _$TS_ROOT_ where applicable.
> I think this would be an important release goal for the 3.0 release since
> that branch is intended for productive use, not by developers. If someone
> provides me the information or has all needed information in a written form,
> I could assist to provide man pages.
> I'm aware there is some documentation for _traffic_shell_ commands. I'm
> unsure if the documentation there reflects the most recent development and is
> generally up to date. If it is still suitable for ATS as of today, it should
> be merged with any newly created documentation. As a remark: I remember there
> was some discussion in the past, where to install the man pages because of
> the rather generic names, for example "enable", "disable", "exit", ...
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira
