Skip to content

Add missing configuration files man pages #8861

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bneradt merged 2 commits into from
May 25, 2022
+56 −25
Merged

Add missing configuration files man pages #8861

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fde947f
Add missing sni.yaml and strategies.yaml man pages. Improve file read…
May 24, 2022
66c2855
Fix autopep8 test
May 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 56 additions & 25 deletions doc/manpages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,34 +21,65 @@
# pages
('developer-guide/api/functions/' + filename[:-4], filename.split('.', 1)[0], filename.split('.', 1)[0] + ' API function', None, '3ts') for filename in os.listdir('developer-guide/api/functions/') if filename != 'index.en.rst' and filename.endswith('.rst')] + [

('appendices/command-line/traffic_ctl.en', 'traffic_ctl', u'Traffic Server command line tool', None, '8'),
('appendices/command-line/traffic_crashlog.en', 'traffic_crashlog', u'Traffic Server crash log helper', None, '8'),
('appendices/command-line/traffic_logcat.en', 'traffic_logcat', u'Traffic Server log spooler', None, '8'),
('appendices/command-line/traffic_logstats.en', 'traffic_logstats', u'Traffic Server analyzer', None, '8'),
('appendices/command-line/traffic_manager.en', 'traffic_manager', u'Traffic Server process manager', None, '8'),
('appendices/command-line/traffic_server.en', 'traffic_server', u'Traffic Server', None, '8'),
# Add all files in the appendices/command-line directory to the list
# of manual pages
('appendices/command-line/traffic_cache_tool.en', 'traffic_cache_tool',
u'Traffic Server cache management tool', None, '1'),
('appendices/command-line/traffic_crashlog.en', 'traffic_crashlog',
u'Traffic Server crash log helper', None, '8'),
('appendices/command-line/traffic_ctl.en', 'traffic_ctl',
u'Traffic Server command line tool', None, '8'),
('appendices/command-line/traffic_layout.en', 'traffic_layout',
u'Traffic Server sandbox management tool', None, '1'),
('appendices/command-line/traffic_logcat.en', 'traffic_logcat',
u'Traffic Server log spooler', None, '8'),
('appendices/command-line/traffic_logstats.en', 'traffic_logstats',
u'Traffic Server analyzer', None, '8'),
('appendices/command-line/traffic_manager.en', 'traffic_manager',
u'Traffic Server process manager', None, '8'),
('appendices/command-line/traffic_server.en', 'traffic_server',
u'Traffic Server', None, '8'),
('appendices/command-line/traffic_top.en', 'traffic_top',
u'Display Traffic Server statistics', None, '1'),
('appendices/command-line/traffic_via.en', 'traffic_via',
u'Traffic Server Via header decoder', None, '1'),
('appendices/command-line/traffic_wccp.en', 'traffic_wccp',
u'Traffic Server WCCP client', None, '1'),
('appendices/command-line/tspush.en', 'tspush',
u'Push objects into the Traffic Server cache', None, '1'),
('appendices/command-line/tsxs.en', 'tsxs',
u'Traffic Server plugin tool', None, '1'),

('appendices/command-line/tspush.en', 'tspush', u'Push objects into the Traffic Server cache', None, '1'),
('appendices/command-line/traffic_top.en', 'traffic_top', u'Display Traffic Server statistics', None, '1'),
('appendices/command-line/tsxs.en', 'tsxs', u'Traffic Server plugin tool', None, '1'),
('appendices/command-line/traffic_via.en', 'traffic_via', u'Traffic Server Via header decoder', None, '1'),
('appendices/command-line/traffic_layout.en', 'traffic_layout', u'Traffic Server sandbox management tool', None, '1'),
('appendices/command-line/traffic_cache_tool.en', 'traffic_cache_tool', u'Traffic Server cache management tool', None, '1'),
('appendices/command-line/traffic_wccp.en', 'traffic_wccp', u'Traffic Server WCCP client', None, '1'),

('admin-guide/files/cache.config.en', 'cache.config', u'Traffic Server cache configuration file', None, '5'),
('admin-guide/files/hosting.config.en', 'hosting.config', u'Traffic Server domain hosting configuration file', None, '5'),
('admin-guide/files/ip_allow.yaml.en', 'ip_allow.yaml', u'Traffic Server IP access control configuration file', None, '5'),
('admin-guide/files/logging.yaml.en', 'logging.yaml', u'Traffic Server logging configuration file', None, '5'),
('admin-guide/files/parent.config.en', 'parent.config', u'Traffic Server parent cache configuration file', None, '5'),
('admin-guide/files/plugin.config.en', 'plugin.config', u'Traffic Server global plugin configuration file', None, '5'),
('admin-guide/files/records.config.en', 'records.config', u'Traffic Server configuration file', None, '5'),
('admin-guide/files/remap.config.en', 'remap.config', u'Traffic Server remap rules configuration file', None, '5'),
('admin-guide/files/splitdns.config.en', 'splitdns.config', u'Traffic Server split DNS configuration file', None, '5'),
# Add all files in the admin-guide/files directory to the list
# of manual pages
('admin-guide/files/cache.config.en', 'cache.config',
u'Traffic Server cache configuration file', None, '5'),
('admin-guide/files/hosting.config.en', 'hosting.config',
u'Traffic Server domain hosting configuration file', None, '5'),
('admin-guide/files/ip_allow.yaml.en', 'ip_allow.yaml',
u'Traffic Server IP access control configuration file', None, '5'),
('admin-guide/files/logging.yaml.en', 'logging.yaml',
u'Traffic Server logging configuration file', None, '5'),
('admin-guide/files/parent.config.en', 'parent.config',
u'Traffic Server parent cache configuration file', None, '5'),
('admin-guide/files/plugin.config.en', 'plugin.config',
u'Traffic Server global plugin configuration file', None, '5'),
('admin-guide/files/records.config.en', 'records.config',
u'Traffic Server configuration file', None, '5'),
('admin-guide/files/remap.config.en', 'remap.config',
u'Traffic Server remap rules configuration file', None, '5'),
('admin-guide/files/sni.yaml.en', 'sni.yaml',
u'Traffic Server sni rules configuration file', None, '5'),
('admin-guide/files/splitdns.config.en', 'splitdns.config',
u'Traffic Server split DNS configuration file', None, '5'),
('admin-guide/files/ssl_multicert.config.en', 'ssl_multicert.config',
u'Traffic Server SSL certificate configuration file', None, '5'),
('admin-guide/files/storage.config.en', 'storage.config', u'Traffic Server cache storage configuration file', None, '5'),
('admin-guide/files/volume.config.en', 'volume.config', u'Traffic Server cache volume configuration file', None, '5'),
('admin-guide/files/storage.config.en', 'storage.config',
u'Traffic Server cache storage configuration file', None, '5'),
('admin-guide/files/strategies.yaml.en', 'strategies.yaml',
u'Traffic Server cache hierarchy configuration file', None, '5'),
('admin-guide/files/volume.config.en', 'volume.config',
u'Traffic Server cache volume configuration file', None, '5'),

]

Expand Down