1# nghttp2 - HTTP/2 C Library 2 3# Copyright (c) 2012 Tatsuhiro Tsujikawa 4 5# Permission is hereby granted, free of charge, to any person obtaining 6# a copy of this software and associated documentation files (the 7# "Software"), to deal in the Software without restriction, including 8# without limitation the rights to use, copy, modify, merge, publish, 9# distribute, sublicense, and/or sell copies of the Software, and to 10# permit persons to whom the Software is furnished to do so, subject to 11# the following conditions: 12 13# The above copyright notice and this permission notice shall be 14# included in all copies or substantial portions of the Software. 15 16# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 17# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 18# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 19# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 20# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 21# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 22# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 23 24man_MANS = nghttp.1 nghttpd.1 nghttpx.1 h2load.1 25 26APIDOCS= \ 27 macros.rst \ 28 enums.rst \ 29 types.rst \ 30 nghttp2_check_authority.rst \ 31 nghttp2_check_header_name.rst \ 32 nghttp2_check_header_value.rst \ 33 nghttp2_hd_deflate_bound.rst \ 34 nghttp2_hd_deflate_change_table_size.rst \ 35 nghttp2_hd_deflate_del.rst \ 36 nghttp2_hd_deflate_get_dynamic_table_size.rst \ 37 nghttp2_hd_deflate_get_max_dynamic_table_size.rst \ 38 nghttp2_hd_deflate_get_num_table_entries.rst \ 39 nghttp2_hd_deflate_get_table_entry.rst \ 40 nghttp2_hd_deflate_hd.rst \ 41 nghttp2_hd_deflate_hd_vec.rst \ 42 nghttp2_hd_deflate_new.rst \ 43 nghttp2_hd_deflate_new2.rst \ 44 nghttp2_hd_inflate_change_table_size.rst \ 45 nghttp2_hd_inflate_del.rst \ 46 nghttp2_hd_inflate_end_headers.rst \ 47 nghttp2_hd_inflate_get_dynamic_table_size.rst \ 48 nghttp2_hd_inflate_get_max_dynamic_table_size.rst \ 49 nghttp2_hd_inflate_get_num_table_entries.rst \ 50 nghttp2_hd_inflate_get_table_entry.rst \ 51 nghttp2_hd_inflate_hd.rst \ 52 nghttp2_hd_inflate_hd2.rst \ 53 nghttp2_hd_inflate_new.rst \ 54 nghttp2_hd_inflate_new2.rst \ 55 nghttp2_http2_strerror.rst \ 56 nghttp2_is_fatal.rst \ 57 nghttp2_nv_compare_name.rst \ 58 nghttp2_option_del.rst \ 59 nghttp2_option_new.rst \ 60 nghttp2_option_set_builtin_recv_extension_type.rst \ 61 nghttp2_option_set_max_deflate_dynamic_table_size.rst \ 62 nghttp2_option_set_max_reserved_remote_streams.rst \ 63 nghttp2_option_set_max_send_header_block_length.rst \ 64 nghttp2_option_set_no_auto_ping_ack.rst \ 65 nghttp2_option_set_no_auto_window_update.rst \ 66 nghttp2_option_set_no_closed_streams.rst \ 67 nghttp2_option_set_no_http_messaging.rst \ 68 nghttp2_option_set_no_recv_client_magic.rst \ 69 nghttp2_option_set_peer_max_concurrent_streams.rst \ 70 nghttp2_option_set_user_recv_extension_type.rst \ 71 nghttp2_option_set_max_outbound_ack.rst \ 72 nghttp2_option_set_max_settings.rst \ 73 nghttp2_pack_settings_payload.rst \ 74 nghttp2_priority_spec_check_default.rst \ 75 nghttp2_priority_spec_default_init.rst \ 76 nghttp2_priority_spec_init.rst \ 77 nghttp2_rcbuf_decref.rst \ 78 nghttp2_rcbuf_get_buf.rst \ 79 nghttp2_rcbuf_incref.rst \ 80 nghttp2_rcbuf_is_static.rst \ 81 nghttp2_select_next_protocol.rst \ 82 nghttp2_session_callbacks_del.rst \ 83 nghttp2_session_callbacks_new.rst \ 84 nghttp2_session_callbacks_set_before_frame_send_callback.rst \ 85 nghttp2_session_callbacks_set_data_source_read_length_callback.rst \ 86 nghttp2_session_callbacks_set_error_callback.rst \ 87 nghttp2_session_callbacks_set_error_callback2.rst \ 88 nghttp2_session_callbacks_set_on_begin_frame_callback.rst \ 89 nghttp2_session_callbacks_set_on_begin_headers_callback.rst \ 90 nghttp2_session_callbacks_set_on_data_chunk_recv_callback.rst \ 91 nghttp2_session_callbacks_set_on_extension_chunk_recv_callback.rst \ 92 nghttp2_session_callbacks_set_on_frame_not_send_callback.rst \ 93 nghttp2_session_callbacks_set_on_frame_recv_callback.rst \ 94 nghttp2_session_callbacks_set_on_frame_send_callback.rst \ 95 nghttp2_session_callbacks_set_on_header_callback.rst \ 96 nghttp2_session_callbacks_set_on_header_callback2.rst \ 97 nghttp2_session_callbacks_set_on_invalid_frame_recv_callback.rst \ 98 nghttp2_session_callbacks_set_on_invalid_header_callback.rst \ 99 nghttp2_session_callbacks_set_on_invalid_header_callback2.rst \ 100 nghttp2_session_callbacks_set_on_stream_close_callback.rst \ 101 nghttp2_session_callbacks_set_pack_extension_callback.rst \ 102 nghttp2_session_callbacks_set_recv_callback.rst \ 103 nghttp2_session_callbacks_set_select_padding_callback.rst \ 104 nghttp2_session_callbacks_set_send_callback.rst \ 105 nghttp2_session_callbacks_set_send_data_callback.rst \ 106 nghttp2_session_callbacks_set_unpack_extension_callback.rst \ 107 nghttp2_session_change_stream_priority.rst \ 108 nghttp2_session_check_request_allowed.rst \ 109 nghttp2_session_check_server_session.rst \ 110 nghttp2_session_client_new.rst \ 111 nghttp2_session_client_new2.rst \ 112 nghttp2_session_client_new3.rst \ 113 nghttp2_session_consume.rst \ 114 nghttp2_session_consume_connection.rst \ 115 nghttp2_session_consume_stream.rst \ 116 nghttp2_session_create_idle_stream.rst \ 117 nghttp2_session_del.rst \ 118 nghttp2_session_find_stream.rst \ 119 nghttp2_session_get_effective_local_window_size.rst \ 120 nghttp2_session_get_effective_recv_data_length.rst \ 121 nghttp2_session_get_hd_deflate_dynamic_table_size.rst \ 122 nghttp2_session_get_hd_inflate_dynamic_table_size.rst \ 123 nghttp2_session_get_last_proc_stream_id.rst \ 124 nghttp2_session_get_local_settings.rst \ 125 nghttp2_session_get_local_window_size.rst \ 126 nghttp2_session_get_next_stream_id.rst \ 127 nghttp2_session_get_outbound_queue_size.rst \ 128 nghttp2_session_get_remote_settings.rst \ 129 nghttp2_session_get_remote_window_size.rst \ 130 nghttp2_session_get_root_stream.rst \ 131 nghttp2_session_get_stream_effective_local_window_size.rst \ 132 nghttp2_session_get_stream_effective_recv_data_length.rst \ 133 nghttp2_session_get_stream_local_close.rst \ 134 nghttp2_session_get_stream_local_window_size.rst \ 135 nghttp2_session_get_stream_remote_close.rst \ 136 nghttp2_session_get_stream_remote_window_size.rst \ 137 nghttp2_session_get_stream_user_data.rst \ 138 nghttp2_session_mem_recv.rst \ 139 nghttp2_session_mem_send.rst \ 140 nghttp2_session_recv.rst \ 141 nghttp2_session_resume_data.rst \ 142 nghttp2_session_send.rst \ 143 nghttp2_session_server_new.rst \ 144 nghttp2_session_server_new2.rst \ 145 nghttp2_session_server_new3.rst \ 146 nghttp2_session_set_local_window_size.rst \ 147 nghttp2_session_set_next_stream_id.rst \ 148 nghttp2_session_set_stream_user_data.rst \ 149 nghttp2_session_set_user_data.rst \ 150 nghttp2_session_terminate_session.rst \ 151 nghttp2_session_terminate_session2.rst \ 152 nghttp2_session_upgrade.rst \ 153 nghttp2_session_upgrade2.rst \ 154 nghttp2_session_want_read.rst \ 155 nghttp2_session_want_write.rst \ 156 nghttp2_set_debug_vprintf_callback.rst \ 157 nghttp2_stream_get_first_child.rst \ 158 nghttp2_stream_get_next_sibling.rst \ 159 nghttp2_stream_get_parent.rst \ 160 nghttp2_stream_get_previous_sibling.rst \ 161 nghttp2_stream_get_state.rst \ 162 nghttp2_stream_get_sum_dependency_weight.rst \ 163 nghttp2_stream_get_weight.rst \ 164 nghttp2_strerror.rst \ 165 nghttp2_submit_altsvc.rst \ 166 nghttp2_submit_data.rst \ 167 nghttp2_submit_extension.rst \ 168 nghttp2_submit_goaway.rst \ 169 nghttp2_submit_headers.rst \ 170 nghttp2_submit_origin.rst \ 171 nghttp2_submit_ping.rst \ 172 nghttp2_submit_priority.rst \ 173 nghttp2_submit_push_promise.rst \ 174 nghttp2_submit_request.rst \ 175 nghttp2_submit_response.rst \ 176 nghttp2_submit_rst_stream.rst \ 177 nghttp2_submit_settings.rst \ 178 nghttp2_submit_shutdown_notice.rst \ 179 nghttp2_submit_trailer.rst \ 180 nghttp2_submit_window_update.rst \ 181 nghttp2_version.rst 182 183RST_FILES = \ 184 README.rst \ 185 programmers-guide.rst \ 186 nghttp.1.rst \ 187 nghttpd.1.rst \ 188 nghttpx.1.rst \ 189 h2load.1.rst 190 191EXTRA_DIST = \ 192 CMakeLists.txt \ 193 mkapiref.py \ 194 $(RST_FILES) \ 195 $(APIDOCS) \ 196 sources/index.rst \ 197 sources/tutorial-client.rst \ 198 sources/tutorial-server.rst \ 199 sources/tutorial-hpack.rst \ 200 sources/nghttpx-howto.rst \ 201 sources/h2load-howto.rst \ 202 sources/libnghttp2_asio.rst \ 203 sources/python-apiref.rst \ 204 sources/building-android-binary.rst \ 205 sources/contribute.rst \ 206 sources/security.rst \ 207 _exts/sphinxcontrib/LICENSE.rubydomain \ 208 _exts/sphinxcontrib/__init__.py \ 209 _exts/sphinxcontrib/rubydomain.py \ 210 _themes/sphinx_rtd_theme/__init__.py \ 211 _themes/sphinx_rtd_theme/breadcrumbs.html \ 212 _themes/sphinx_rtd_theme/footer.html \ 213 _themes/sphinx_rtd_theme/layout.html \ 214 _themes/sphinx_rtd_theme/locale/de/LC_MESSAGES/sphinx.mo \ 215 _themes/sphinx_rtd_theme/locale/de/LC_MESSAGES/sphinx.po \ 216 _themes/sphinx_rtd_theme/locale/en/LC_MESSAGES/sphinx.mo \ 217 _themes/sphinx_rtd_theme/locale/en/LC_MESSAGES/sphinx.po \ 218 _themes/sphinx_rtd_theme/locale/es/LC_MESSAGES/sphinx.mo \ 219 _themes/sphinx_rtd_theme/locale/es/LC_MESSAGES/sphinx.po \ 220 _themes/sphinx_rtd_theme/locale/et/LC_MESSAGES/sphinx.mo \ 221 _themes/sphinx_rtd_theme/locale/et/LC_MESSAGES/sphinx.po \ 222 _themes/sphinx_rtd_theme/locale/fr/LC_MESSAGES/sphinx.mo \ 223 _themes/sphinx_rtd_theme/locale/fr/LC_MESSAGES/sphinx.po \ 224 _themes/sphinx_rtd_theme/locale/nl/LC_MESSAGES/sphinx.mo \ 225 _themes/sphinx_rtd_theme/locale/nl/LC_MESSAGES/sphinx.po \ 226 _themes/sphinx_rtd_theme/locale/pt_BR/LC_MESSAGES/sphinx.mo \ 227 _themes/sphinx_rtd_theme/locale/pt_BR/LC_MESSAGES/sphinx.po \ 228 _themes/sphinx_rtd_theme/locale/ru/LC_MESSAGES/sphinx.mo \ 229 _themes/sphinx_rtd_theme/locale/ru/LC_MESSAGES/sphinx.po \ 230 _themes/sphinx_rtd_theme/locale/sphinx.pot \ 231 _themes/sphinx_rtd_theme/locale/sv/LC_MESSAGES/sphinx.mo \ 232 _themes/sphinx_rtd_theme/locale/sv/LC_MESSAGES/sphinx.po \ 233 _themes/sphinx_rtd_theme/locale/tr/LC_MESSAGES/sphinx.mo \ 234 _themes/sphinx_rtd_theme/locale/tr/LC_MESSAGES/sphinx.po \ 235 _themes/sphinx_rtd_theme/locale/zh_CN/LC_MESSAGES/sphinx.mo \ 236 _themes/sphinx_rtd_theme/locale/zh_CN/LC_MESSAGES/sphinx.po \ 237 _themes/sphinx_rtd_theme/search.html \ 238 _themes/sphinx_rtd_theme/searchbox.html \ 239 _themes/sphinx_rtd_theme/static/css/badge_only.css \ 240 _themes/sphinx_rtd_theme/static/css/fonts/Roboto-Slab-Bold.woff \ 241 _themes/sphinx_rtd_theme/static/css/fonts/Roboto-Slab-Bold.woff2 \ 242 _themes/sphinx_rtd_theme/static/css/fonts/Roboto-Slab-Regular.woff \ 243 _themes/sphinx_rtd_theme/static/css/fonts/Roboto-Slab-Regular.woff2 \ 244 _themes/sphinx_rtd_theme/static/css/fonts/fontawesome-webfont.eot \ 245 _themes/sphinx_rtd_theme/static/css/fonts/fontawesome-webfont.svg \ 246 _themes/sphinx_rtd_theme/static/css/fonts/fontawesome-webfont.ttf \ 247 _themes/sphinx_rtd_theme/static/css/fonts/fontawesome-webfont.woff \ 248 _themes/sphinx_rtd_theme/static/css/fonts/fontawesome-webfont.woff2 \ 249 _themes/sphinx_rtd_theme/static/css/fonts/lato-bold-italic.woff \ 250 _themes/sphinx_rtd_theme/static/css/fonts/lato-bold-italic.woff2 \ 251 _themes/sphinx_rtd_theme/static/css/fonts/lato-bold.woff \ 252 _themes/sphinx_rtd_theme/static/css/fonts/lato-bold.woff2 \ 253 _themes/sphinx_rtd_theme/static/css/fonts/lato-normal-italic.woff \ 254 _themes/sphinx_rtd_theme/static/css/fonts/lato-normal-italic.woff2 \ 255 _themes/sphinx_rtd_theme/static/css/fonts/lato-normal.woff \ 256 _themes/sphinx_rtd_theme/static/css/fonts/lato-normal.woff2 \ 257 _themes/sphinx_rtd_theme/static/css/theme.css \ 258 _themes/sphinx_rtd_theme/static/js/badge_only.js \ 259 _themes/sphinx_rtd_theme/static/js/theme.js \ 260 _themes/sphinx_rtd_theme/theme.conf \ 261 _themes/sphinx_rtd_theme/versions.html \ 262 $(man_MANS) \ 263 bash_completion/nghttp \ 264 bash_completion/nghttpd \ 265 bash_completion/nghttpx \ 266 bash_completion/h2load 267 268# Makefile for Sphinx documentation 269# 270 271# You can set these variables from the command line. 272SPHINXOPTS = 273SPHINXBUILD = sphinx-build 274PAPER = 275BUILDDIR = manual 276 277# Internal variables. 278PAPEROPT_a4 = -D latex_paper_size=a4 279PAPEROPT_letter = -D latex_paper_size=letter 280ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 281 282.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest 283 284help: 285 @echo "Please use \`make <target>' where <target> is one of" 286 @echo " html to make standalone HTML files" 287 @echo " dirhtml to make HTML files named index.html in directories" 288 @echo " singlehtml to make a single large HTML file" 289 @echo " pickle to make pickle files" 290 @echo " json to make JSON files" 291 @echo " htmlhelp to make HTML files and a HTML help project" 292 @echo " qthelp to make HTML files and a qthelp project" 293 @echo " devhelp to make HTML files and a Devhelp project" 294 @echo " epub to make an epub" 295 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 296 @echo " latexpdf to make LaTeX files and run them through pdflatex" 297 @echo " text to make text files" 298 @echo " man to make manual pages" 299 @echo " changes to make an overview of all changed/added/deprecated items" 300 @echo " linkcheck to check all external links for integrity" 301 @echo " doctest to run all doctests embedded in the documentation (if enabled)" 302 303apiref.rst: \ 304 $(top_builddir)/lib/includes/nghttp2/nghttp2ver.h \ 305 $(top_srcdir)/lib/includes/nghttp2/nghttp2.h 306 for i in $(RST_FILES); do [ -e $(builddir)/$$i ] || cp $(srcdir)/$$i $(builddir); done 307 $(PYTHON) $(top_srcdir)/doc/mkapiref.py \ 308 apiref.rst macros.rst enums.rst types.rst . $^ 309 310$(APIDOCS): apiref.rst 311 312clean-local: 313 if [ $(srcdir) != $(builddir) ]; then for i in $(RST_FILES); do rm -f $(builddir)/$$i; done fi 314 -rm -f apiref.rst 315 -rm -f $(APIDOCS) 316 -rm -rf $(BUILDDIR)/* 317 318html-local: apiref.rst 319 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 320 @echo 321 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 322 323dirhtml: 324 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 325 @echo 326 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 327 328singlehtml: 329 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 330 @echo 331 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 332 333pickle: 334 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 335 @echo 336 @echo "Build finished; now you can process the pickle files." 337 338json: 339 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 340 @echo 341 @echo "Build finished; now you can process the JSON files." 342 343htmlhelp: 344 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 345 @echo 346 @echo "Build finished; now you can run HTML Help Workshop with the" \ 347 ".hhp project file in $(BUILDDIR)/htmlhelp." 348 349qthelp: 350 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 351 @echo 352 @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 353 ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 354 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/nghttp2.qhcp" 355 @echo "To view the help file:" 356 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/nghttp2.qhc" 357 358devhelp: 359 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 360 @echo 361 @echo "Build finished." 362 @echo "To view the help file:" 363 @echo "# mkdir -p $$HOME/.local/share/devhelp/nghttp2" 364 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/nghttp2" 365 @echo "# devhelp" 366 367epub: 368 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 369 @echo 370 @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 371 372latex: 373 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 374 @echo 375 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 376 @echo "Run \`make' in that directory to run these through (pdf)latex" \ 377 "(use \`make latexpdf' here to do that automatically)." 378 379latexpdf: 380 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 381 @echo "Running LaTeX files through pdflatex..." 382 $(MAKE) -C $(BUILDDIR)/latex all-pdf 383 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 384 385text: 386 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 387 @echo 388 @echo "Build finished. The text files are in $(BUILDDIR)/text." 389 390man: apiref.rst 391 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 392 @echo 393 @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 394 395changes: 396 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 397 @echo 398 @echo "The overview file is in $(BUILDDIR)/changes." 399 400linkcheck: 401 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 402 @echo 403 @echo "Link check complete; look for any errors in the above output " \ 404 "or in $(BUILDDIR)/linkcheck/output.txt." 405 406doctest: 407 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 408 @echo "Testing of doctests in the sources finished, look at the " \ 409 "results in $(BUILDDIR)/doctest/output.txt." 410
