comparison xml/ru/docs/http/ngx_http_core_module.xml @ 768:f63b7fa3bf17

Added "id" attributes to http core module variables.
author Vladimir Homutov <vl@nginx.com>
date Mon, 19 Nov 2012 14:44:56 +0000
parents 1bb8b733416a
children d71e56d56ada
comparison
equal deleted inserted replaced
767:1bb8b733416a 768:f63b7fa3bf17
2674 запроса клиента, такие как <var>$http_user_agent</var>, <var>$http_cookie</var> 2674 запроса клиента, такие как <var>$http_user_agent</var>, <var>$http_cookie</var>
2675 и тому подобное. 2675 и тому подобное.
2676 Кроме того, есть и другие переменные: 2676 Кроме того, есть и другие переменные:
2677 <list type="tag"> 2677 <list type="tag">
2678 2678
2679 <tag-name><var>$arg_</var><value>имя</value></tag-name> 2679 <tag-name id="var_arg_"><var>$arg_</var><value>имя</value></tag-name>
2680 <tag-desc> 2680 <tag-desc>
2681 аргумент <value>имя</value> в строке запроса 2681 аргумент <value>имя</value> в строке запроса
2682 </tag-desc> 2682 </tag-desc>
2683 2683
2684 <tag-name><var>$args</var></tag-name> 2684 <tag-name id="var_args"><var>$args</var></tag-name>
2685 <tag-desc> 2685 <tag-desc>
2686 аргументы в строке запроса 2686 аргументы в строке запроса
2687 </tag-desc> 2687 </tag-desc>
2688 2688
2689 <tag-name><var>$binary_remote_addr</var></tag-name> 2689 <tag-name id="var_binary_remote_addr"><var>$binary_remote_addr</var></tag-name>
2690 <tag-desc> 2690 <tag-desc>
2691 адрес клиента в бинарном виде, длина значения всегда 4 байта 2691 адрес клиента в бинарном виде, длина значения всегда 4 байта
2692 </tag-desc> 2692 </tag-desc>
2693 2693
2694 <tag-name><var>$body_bytes_sent</var></tag-name> 2694 <tag-name id="var_body_bytes_sent"><var>$body_bytes_sent</var></tag-name>
2695 <tag-desc> 2695 <tag-desc>
2696 число байт, переданное клиенту, без учёта заголовка ответа 2696 число байт, переданное клиенту, без учёта заголовка ответа
2697 </tag-desc> 2697 </tag-desc>
2698 2698
2699 <tag-name><var>$content_length</var></tag-name> 2699 <tag-name id="var_content_length"><var>$content_length</var></tag-name>
2700 <tag-desc> 2700 <tag-desc>
2701 поле <header>Content-Length</header> заголовка запроса 2701 поле <header>Content-Length</header> заголовка запроса
2702 </tag-desc> 2702 </tag-desc>
2703 2703
2704 <tag-name><var>$content_type</var></tag-name> 2704 <tag-name id="var_content_type"><var>$content_type</var></tag-name>
2705 <tag-desc> 2705 <tag-desc>
2706 поле <header>Content-Type</header> заголовка запроса 2706 поле <header>Content-Type</header> заголовка запроса
2707 </tag-desc> 2707 </tag-desc>
2708 2708
2709 <tag-name><var>$cookie_</var><value>имя</value></tag-name> 2709 <tag-name id="var_cookie_"><var>$cookie_</var><value>имя</value></tag-name>
2710 <tag-desc> 2710 <tag-desc>
2711 cookie <value>имя</value> 2711 cookie <value>имя</value>
2712 </tag-desc> 2712 </tag-desc>
2713 2713
2714 <tag-name><var>$document_root</var></tag-name> 2714 <tag-name id="var_document_root"><var>$document_root</var></tag-name>
2715 <tag-desc> 2715 <tag-desc>
2716 значение директивы <link id="root"/> или <link id="alias"/> 2716 значение директивы <link id="root"/> или <link id="alias"/>
2717 для текущего запроса 2717 для текущего запроса
2718 </tag-desc> 2718 </tag-desc>
2719 2719
2720 <tag-name><var>$document_uri</var></tag-name> 2720 <tag-name id="var_document_uri"><var>$document_uri</var></tag-name>
2721 <tag-desc> 2721 <tag-desc>
2722 то же, что и <var>$uri</var> 2722 то же, что и <var>$uri</var>
2723 </tag-desc> 2723 </tag-desc>
2724 2724
2725 <tag-name><var>$host</var></tag-name> 2725 <tag-name id="var_host"><var>$host</var></tag-name>
2726 <tag-desc> 2726 <tag-desc>
2727 поле <header>Host</header> заголовка запроса, 2727 поле <header>Host</header> заголовка запроса,
2728 или имя сервера, соответствующего запросу, если этого поля нет 2728 или имя сервера, соответствующего запросу, если этого поля нет
2729 </tag-desc> 2729 </tag-desc>
2730 2730
2731 <tag-name><var>$hostname</var></tag-name> 2731 <tag-name id="var_hostname"><var>$hostname</var></tag-name>
2732 <tag-desc> 2732 <tag-desc>
2733 имя хоста 2733 имя хоста
2734 </tag-desc> 2734 </tag-desc>
2735 2735
2736 <tag-name><var>$http_</var><value>имя</value></tag-name> 2736 <tag-name id="var_http_"><var>$http_</var><value>имя</value></tag-name>
2737 <tag-desc> 2737 <tag-desc>
2738 произвольное поле заголовка запроса; 2738 произвольное поле заголовка запроса;
2739 последняя часть имени переменной соответствует имени поля, приведённому 2739 последняя часть имени переменной соответствует имени поля, приведённому
2740 к нижнему регистру, с заменой символов тире на символы подчёркивания 2740 к нижнему регистру, с заменой символов тире на символы подчёркивания
2741 </tag-desc> 2741 </tag-desc>
2742 2742
2743 <tag-name><var>$https</var></tag-name> 2743 <tag-name id="var_https"><var>$https</var></tag-name>
2744 <tag-desc> 2744 <tag-desc>
2745 “<literal>on</literal>” 2745 “<literal>on</literal>”
2746 если соединение работает в режиме SSL, 2746 если соединение работает в режиме SSL,
2747 либо пустая строка 2747 либо пустая строка
2748 </tag-desc> 2748 </tag-desc>
2749 2749
2750 <tag-name><var>$is_args</var></tag-name> 2750 <tag-name id="var_is_args"><var>$is_args</var></tag-name>
2751 <tag-desc> 2751 <tag-desc>
2752 “<literal>?</literal>”, если в строке запроса есть аргументы, 2752 “<literal>?</literal>”, если в строке запроса есть аргументы,
2753 и пустая строка, если их нет 2753 и пустая строка, если их нет
2754 </tag-desc> 2754 </tag-desc>
2755 2755
2756 <tag-name><var>$limit_rate</var></tag-name> 2756 <tag-name id="var_limit_rate"><var>$limit_rate</var></tag-name>
2757 <tag-desc> 2757 <tag-desc>
2758 установка этой переменной позволяет ограничивать скорость 2758 установка этой переменной позволяет ограничивать скорость
2759 передачи ответа, см. <link id="limit_rate"/> 2759 передачи ответа, см. <link id="limit_rate"/>
2760 </tag-desc> 2760 </tag-desc>
2761 2761
2762 <tag-name><var>$nginx_version</var></tag-name> 2762 <tag-name id="var_nginx_version"><var>$nginx_version</var></tag-name>
2763 <tag-desc> 2763 <tag-desc>
2764 версия nginx 2764 версия nginx
2765 </tag-desc> 2765 </tag-desc>
2766 2766
2767 <tag-name><var>$pid</var></tag-name> 2767 <tag-name id="var_pid"><var>$pid</var></tag-name>
2768 <tag-desc> 2768 <tag-desc>
2769 номер (PID) рабочего процесса 2769 номер (PID) рабочего процесса
2770 </tag-desc> 2770 </tag-desc>
2771 2771
2772 <tag-name><var>$query_string</var></tag-name> 2772 <tag-name id="var_query_string"><var>$query_string</var></tag-name>
2773 <tag-desc> 2773 <tag-desc>
2774 то же, что и <var>$args</var> 2774 то же, что и <var>$args</var>
2775 </tag-desc> 2775 </tag-desc>
2776 2776
2777 <tag-name><var>$realpath_root</var></tag-name> 2777 <tag-name id="var_realpath_root"><var>$realpath_root</var></tag-name>
2778 <tag-desc> 2778 <tag-desc>
2779 абсолютный путь, соответствующий 2779 абсолютный путь, соответствующий
2780 значению директивы <link id="root"/> или <link id="alias"/> 2780 значению директивы <link id="root"/> или <link id="alias"/>
2781 для текущего запроса, 2781 для текущего запроса,
2782 в котором все символические ссылки преобразованы в реальные пути 2782 в котором все символические ссылки преобразованы в реальные пути
2783 </tag-desc> 2783 </tag-desc>
2784 2784
2785 <tag-name><var>$remote_addr</var></tag-name> 2785 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
2786 <tag-desc> 2786 <tag-desc>
2787 адрес клиента 2787 адрес клиента
2788 </tag-desc> 2788 </tag-desc>
2789 2789
2790 <tag-name><var>$remote_port</var></tag-name> 2790 <tag-name id="var_remote_port"><var>$remote_port</var></tag-name>
2791 <tag-desc> 2791 <tag-desc>
2792 порт клиента 2792 порт клиента
2793 </tag-desc> 2793 </tag-desc>
2794 2794
2795 <tag-name><var>$remote_user</var></tag-name> 2795 <tag-name id="var_remote_user"><var>$remote_user</var></tag-name>
2796 <tag-desc> 2796 <tag-desc>
2797 имя пользователя, использованное в Basic аутентификации 2797 имя пользователя, использованное в Basic аутентификации
2798 </tag-desc> 2798 </tag-desc>
2799 2799
2800 <tag-name><var>$request</var></tag-name> 2800 <tag-name id="var_request"><var>$request</var></tag-name>
2801 <tag-desc> 2801 <tag-desc>
2802 первоначальная строка запроса целиком 2802 первоначальная строка запроса целиком
2803 </tag-desc> 2803 </tag-desc>
2804 2804
2805 <tag-name><var>$request_body</var></tag-name> 2805 <tag-name id="var_request_body"><var>$request_body</var></tag-name>
2806 <tag-desc> 2806 <tag-desc>
2807 тело запроса 2807 тело запроса
2808 <para> 2808 <para>
2809 Значение переменной появляется в location’ах, обрабатываемых 2809 Значение переменной появляется в location’ах, обрабатываемых
2810 директивами 2810 директивами
2812 и 2812 и
2813 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>. 2813 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_pass"/>.
2814 </para> 2814 </para>
2815 </tag-desc> 2815 </tag-desc>
2816 2816
2817 <tag-name><var>$request_body_file</var></tag-name> 2817 <tag-name id="var_request_body_file"><var>$request_body_file</var></tag-name>
2818 <tag-desc> 2818 <tag-desc>
2819 имя временного файла, в котором хранится тело запроса 2819 имя временного файла, в котором хранится тело запроса
2820 <para> 2820 <para>
2821 По завершению обработки файл необходимо удалить. 2821 По завершению обработки файл необходимо удалить.
2822 Для того, чтобы тело запроса всегда записывалось в файл, 2822 Для того, чтобы тело запроса всегда записывалось в файл,
2831 fastcgi_pass_request_body off</link> 2831 fastcgi_pass_request_body off</link>
2832 соответственно. 2832 соответственно.
2833 </para> 2833 </para>
2834 </tag-desc> 2834 </tag-desc>
2835 2835
2836 <tag-name><var>$request_completion</var></tag-name> 2836 <tag-name id="var_request_completion"><var>$request_completion</var></tag-name>
2837 <tag-desc> 2837 <tag-desc>
2838 “<literal>OK</literal>” если запрос завершился, 2838 “<literal>OK</literal>” если запрос завершился,
2839 либо пустая строка 2839 либо пустая строка
2840 </tag-desc> 2840 </tag-desc>
2841 2841
2842 <tag-name><var>$request_filename</var></tag-name> 2842 <tag-name id="var_request_filename"><var>$request_filename</var></tag-name>
2843 <tag-desc> 2843 <tag-desc>
2844 путь к файлу для текущего запроса, формируемый из директив 2844 путь к файлу для текущего запроса, формируемый из директив
2845 <link id="root"/> или <link id="alias"/> и URI запроса 2845 <link id="root"/> или <link id="alias"/> и URI запроса
2846 </tag-desc> 2846 </tag-desc>
2847 2847
2848 <tag-name><var>$request_method</var></tag-name> 2848 <tag-name id="var_request_method"><var>$request_method</var></tag-name>
2849 <tag-desc> 2849 <tag-desc>
2850 метод запроса, обычно 2850 метод запроса, обычно
2851 “<literal>GET</literal>” или “<literal>POST</literal>” 2851 “<literal>GET</literal>” или “<literal>POST</literal>”
2852 </tag-desc> 2852 </tag-desc>
2853 2853
2854 <tag-name><var>$request_uri</var></tag-name> 2854 <tag-name id="var_request_uri"><var>$request_uri</var></tag-name>
2855 <tag-desc> 2855 <tag-desc>
2856 первоначальный URI запроса целиком (с аргументами) 2856 первоначальный URI запроса целиком (с аргументами)
2857 </tag-desc> 2857 </tag-desc>
2858 2858
2859 <tag-name><var>$scheme</var></tag-name> 2859 <tag-name id="var_scheme"><var>$scheme</var></tag-name>
2860 <tag-desc> 2860 <tag-desc>
2861 схема запроса, “<literal>http</literal>” или “<literal>https</literal>” 2861 схема запроса, “<literal>http</literal>” или “<literal>https</literal>”
2862 </tag-desc> 2862 </tag-desc>
2863 2863
2864 <tag-name><var>$sent_http_</var><value>имя</value></tag-name> 2864 <tag-name id="var_sent_http_"><var>$sent_http_</var><value>имя</value></tag-name>
2865 <tag-desc> 2865 <tag-desc>
2866 произвольное поле заголовка ответа; 2866 произвольное поле заголовка ответа;
2867 последняя часть имени переменной соответствует имени поля, приведённому 2867 последняя часть имени переменной соответствует имени поля, приведённому
2868 к нижнему регистру, с заменой символов тире на символы подчёркивания 2868 к нижнему регистру, с заменой символов тире на символы подчёркивания
2869 </tag-desc> 2869 </tag-desc>
2870 2870
2871 <tag-name><var>$server_addr</var></tag-name> 2871 <tag-name id="var_server_addr"><var>$server_addr</var></tag-name>
2872 <tag-desc> 2872 <tag-desc>
2873 адрес сервера, принявшего запрос 2873 адрес сервера, принявшего запрос
2874 <para> 2874 <para>
2875 Получение значения этой переменной обычно требует одного системного вызова. 2875 Получение значения этой переменной обычно требует одного системного вызова.
2876 Чтобы избежать системного вызова, в директивах <link id="listen"/> 2876 Чтобы избежать системного вызова, в директивах <link id="listen"/>
2877 следует указывать адреса и использовать параметр <literal>bind</literal>. 2877 следует указывать адреса и использовать параметр <literal>bind</literal>.
2878 </para> 2878 </para>
2879 </tag-desc> 2879 </tag-desc>
2880 2880
2881 <tag-name><var>$server_name</var></tag-name> 2881 <tag-name id="var_server_name"><var>$server_name</var></tag-name>
2882 <tag-desc> 2882 <tag-desc>
2883 имя сервера, принявшего запрос 2883 имя сервера, принявшего запрос
2884 </tag-desc> 2884 </tag-desc>
2885 2885
2886 <tag-name><var>$server_port</var></tag-name> 2886 <tag-name id="var_server_port"><var>$server_port</var></tag-name>
2887 <tag-desc> 2887 <tag-desc>
2888 порт сервера, принявшего запрос 2888 порт сервера, принявшего запрос
2889 </tag-desc> 2889 </tag-desc>
2890 2890
2891 <tag-name><var>$server_protocol</var></tag-name> 2891 <tag-name id="var_server_protocol"><var>$server_protocol</var></tag-name>
2892 <tag-desc> 2892 <tag-desc>
2893 протокол сервера, обычно 2893 протокол сервера, обычно
2894 “<literal>HTTP/1.0</literal>” 2894 “<literal>HTTP/1.0</literal>”
2895 или 2895 или
2896 “<literal>HTTP/1.1</literal>” 2896 “<literal>HTTP/1.1</literal>”
2897 </tag-desc> 2897 </tag-desc>
2898 2898
2899 <tag-name><var>$status</var></tag-name> 2899 <tag-name id="var_status"><var>$status</var></tag-name>
2900 <tag-desc> 2900 <tag-desc>
2901 статус ответа 2901 статус ответа
2902 </tag-desc> 2902 </tag-desc>
2903 2903
2904 <tag-name> 2904 <tag-name id="var_tcpinfo_">
2905 <var>$tcpinfo_rtt</var>, 2905 <var>$tcpinfo_rtt</var>,
2906 <var>$tcpinfo_rttvar</var>, 2906 <var>$tcpinfo_rttvar</var>,
2907 <var>$tcpinfo_snd_cwnd</var>, 2907 <var>$tcpinfo_snd_cwnd</var>,
2908 <var>$tcpinfo_rcv_space</var> 2908 <var>$tcpinfo_rcv_space</var>
2909 </tag-name> 2909 </tag-name>
2910 <tag-desc> 2910 <tag-desc>
2911 информация о клиентском TCP-соединении; доступна на системах, 2911 информация о клиентском TCP-соединении; доступна на системах,
2912 поддерживающих параметр сокета <c-def>TCP_INFO</c-def> 2912 поддерживающих параметр сокета <c-def>TCP_INFO</c-def>
2913 </tag-desc> 2913 </tag-desc>
2914 2914
2915 <tag-name><var>$uri</var></tag-name> 2915 <tag-name id="var_uri"><var>$uri</var></tag-name>
2916 <tag-desc> 2916 <tag-desc>
2917 текущий URI запроса в <link id="location">нормализованном</link> виде 2917 текущий URI запроса в <link id="location">нормализованном</link> виде
2918 <para> 2918 <para>
2919 Значение <var>$uri</var> может изменяться в процессе обработки запроса, 2919 Значение <var>$uri</var> может изменяться в процессе обработки запроса,
2920 например, при внутренних перенаправлениях 2920 например, при внутренних перенаправлениях