254 lines
6.4 KiB
TeX
254 lines
6.4 KiB
TeX
\documentclass[twoside]{book}
|
|
|
|
% Packages required by doxygen
|
|
\usepackage{fixltx2e}
|
|
\usepackage{calc}
|
|
\usepackage{doxygen}
|
|
\usepackage[export]{adjustbox} % also loads graphicx
|
|
\usepackage{graphicx}
|
|
\usepackage[utf8]{inputenc}
|
|
\usepackage{makeidx}
|
|
\usepackage{multicol}
|
|
\usepackage{multirow}
|
|
\PassOptionsToPackage{warn}{textcomp}
|
|
\usepackage{textcomp}
|
|
\usepackage[nointegrals]{wasysym}
|
|
\usepackage[table]{xcolor}
|
|
|
|
% Font selection
|
|
\usepackage[T1]{fontenc}
|
|
\usepackage[scaled=.90]{helvet}
|
|
\usepackage{courier}
|
|
\usepackage{amssymb}
|
|
\usepackage{sectsty}
|
|
\renewcommand{\familydefault}{\sfdefault}
|
|
\allsectionsfont{%
|
|
\fontseries{bc}\selectfont%
|
|
\color{darkgray}%
|
|
}
|
|
\renewcommand{\DoxyLabelFont}{%
|
|
\fontseries{bc}\selectfont%
|
|
\color{darkgray}%
|
|
}
|
|
\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
|
|
|
|
% Page & text layout
|
|
\usepackage{geometry}
|
|
\geometry{%
|
|
a4paper,%
|
|
top=2.5cm,%
|
|
bottom=2.5cm,%
|
|
left=2.5cm,%
|
|
right=2.5cm%
|
|
}
|
|
\tolerance=750
|
|
\hfuzz=15pt
|
|
\hbadness=750
|
|
\setlength{\emergencystretch}{15pt}
|
|
\setlength{\parindent}{0cm}
|
|
\setlength{\parskip}{3ex plus 2ex minus 2ex}
|
|
\makeatletter
|
|
\renewcommand{\paragraph}{%
|
|
\@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{%
|
|
\normalfont\normalsize\bfseries\SS@parafont%
|
|
}%
|
|
}
|
|
\renewcommand{\subparagraph}{%
|
|
\@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{%
|
|
\normalfont\normalsize\bfseries\SS@subparafont%
|
|
}%
|
|
}
|
|
\makeatother
|
|
|
|
% Headers & footers
|
|
\usepackage{fancyhdr}
|
|
\pagestyle{fancyplain}
|
|
\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}}
|
|
\fancyhead[CE]{\fancyplain{}{}}
|
|
\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}}
|
|
\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}}
|
|
\fancyhead[CO]{\fancyplain{}{}}
|
|
\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}}
|
|
\fancyfoot[LE]{\fancyplain{}{}}
|
|
\fancyfoot[CE]{\fancyplain{}{}}
|
|
\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
|
|
\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated by Doxygen }}
|
|
\fancyfoot[CO]{\fancyplain{}{}}
|
|
\fancyfoot[RO]{\fancyplain{}{}}
|
|
\renewcommand{\footrulewidth}{0.4pt}
|
|
\renewcommand{\chaptermark}[1]{%
|
|
\markboth{#1}{}%
|
|
}
|
|
\renewcommand{\sectionmark}[1]{%
|
|
\markright{\thesection\ #1}%
|
|
}
|
|
|
|
% Indices & bibliography
|
|
\usepackage{natbib}
|
|
\usepackage[titles]{tocloft}
|
|
\setcounter{tocdepth}{3}
|
|
\setcounter{secnumdepth}{5}
|
|
\makeindex
|
|
|
|
% Hyperlinks (required, but should be loaded last)
|
|
\usepackage{ifpdf}
|
|
\ifpdf
|
|
\usepackage[pdftex,pagebackref=true]{hyperref}
|
|
\else
|
|
\usepackage[ps2pdf,pagebackref=true]{hyperref}
|
|
\fi
|
|
\hypersetup{%
|
|
colorlinks=true,%
|
|
linkcolor=blue,%
|
|
citecolor=blue,%
|
|
unicode%
|
|
}
|
|
|
|
% Custom commands
|
|
\newcommand{\clearemptydoublepage}{%
|
|
\newpage{\pagestyle{empty}\cleardoublepage}%
|
|
}
|
|
|
|
\usepackage{caption}
|
|
\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
|
|
|
|
%===== C O N T E N T S =====
|
|
|
|
\begin{document}
|
|
|
|
% Titlepage & ToC
|
|
\hypersetup{pageanchor=false,
|
|
bookmarksnumbered=true,
|
|
pdfencoding=unicode
|
|
}
|
|
\pagenumbering{roman}
|
|
\begin{titlepage}
|
|
\vspace*{7cm}
|
|
\begin{center}%
|
|
{\Large libwebsockets }\\
|
|
\vspace*{1cm}
|
|
{\large Generated by Doxygen 1.8.11}\\
|
|
\end{center}
|
|
\end{titlepage}
|
|
\clearemptydoublepage
|
|
\tableofcontents
|
|
\clearemptydoublepage
|
|
\pagenumbering{arabic}
|
|
\hypersetup{pageanchor=true}
|
|
|
|
%--- Begin generated contents ---
|
|
\chapter{Libwebsockets A\+PI introduction}
|
|
\label{index}\hypertarget{index}{}\input{index}
|
|
\chapter{Notes about building lws}
|
|
\label{md_README.build}
|
|
\hypertarget{md_README.build}{}
|
|
\input{md_README.build}
|
|
\chapter{Debugging problems}
|
|
\label{md_README.problems}
|
|
\hypertarget{md_README.problems}{}
|
|
\input{md_README.problems}
|
|
\chapter{Notes about lwsws}
|
|
\label{md_README.lwsws}
|
|
\hypertarget{md_README.lwsws}{}
|
|
\input{md_README.lwsws}
|
|
\chapter{Notes about coding with lws}
|
|
\label{md_README.coding}
|
|
\hypertarget{md_README.coding}{}
|
|
\input{md_README.coding}
|
|
\chapter{Notes about generic-\/sessions Plugin}
|
|
\label{md_README.generic-sessions}
|
|
\hypertarget{md_README.generic-sessions}{}
|
|
\input{md_README.generic-sessions}
|
|
\chapter{Notes about generic-\/table}
|
|
\label{md_README.generic-table}
|
|
\hypertarget{md_README.generic-table}{}
|
|
\input{md_README.generic-table}
|
|
\chapter{Overview of lws test apps}
|
|
\label{md_README.test-apps}
|
|
\hypertarget{md_README.test-apps}{}
|
|
\input{md_README.test-apps}
|
|
\chapter{Deprecated List}
|
|
\label{deprecated}
|
|
\hypertarget{deprecated}{}
|
|
\input{deprecated}
|
|
\chapter{Module Index}
|
|
\input{modules}
|
|
\chapter{Hierarchical Index}
|
|
\input{hierarchy}
|
|
\chapter{Data Structure Index}
|
|
\input{annotated}
|
|
\chapter{File Index}
|
|
\input{files}
|
|
\chapter{Module Documentation}
|
|
\input{group__service}
|
|
\include{group__callback-when-writeable}
|
|
\include{group__client}
|
|
\include{group__timeout}
|
|
\include{group__context-and-vhost}
|
|
\include{group__extensions}
|
|
\include{group__form-parsing}
|
|
\include{group__html-chunked-substitution}
|
|
\include{group__http}
|
|
\include{group__httpft}
|
|
\include{group__HTTP-headers-create}
|
|
\include{group__HTTP-headers-read}
|
|
\include{group__log}
|
|
\include{group__misc}
|
|
\include{group__net}
|
|
\include{group__Protocols-and-Plugins}
|
|
\include{group__sha}
|
|
\include{group__pur}
|
|
\include{group__sending-data}
|
|
\include{group__smtp}
|
|
\include{group__sock-adopt}
|
|
\include{group__urlendec}
|
|
\include{group__usercb}
|
|
\include{group__vhost-mounts}
|
|
\include{group__wsclose}
|
|
\include{group__wsstatus}
|
|
\include{group__cgi}
|
|
\include{group__fops}
|
|
\include{group__ev}
|
|
\include{group__uv}
|
|
\include{group__generic-sessions}
|
|
\chapter{Data Structure Documentation}
|
|
\input{structlws__cgi__args}
|
|
\input{structlws__client__connect__info}
|
|
\input{classlws__conn}
|
|
\input{classlws__conn__listener}
|
|
\input{structlws__context__creation__info}
|
|
\input{structlws__email}
|
|
\input{structlws__ext__option__arg}
|
|
\input{structlws__ext__options}
|
|
\input{structlws__extension}
|
|
\input{structlws__gs__event__args}
|
|
\input{structlws__http__mount}
|
|
\input{structlws__plat__file__ops}
|
|
\input{structlws__plugin}
|
|
\input{structlws__plugin__capability}
|
|
\input{structlws__polarssl__context}
|
|
\input{structlws__pollargs}
|
|
\input{structlws__pollfd}
|
|
\input{structlws__process__html__args}
|
|
\input{structlws__process__html__state}
|
|
\input{structlws__protocol__vhost__options}
|
|
\input{structlws__protocols}
|
|
\input{structlws__session__info}
|
|
\input{structlws__token__limits}
|
|
\input{structlws__tokens}
|
|
\input{structlwsgw__hash}
|
|
\input{structlwsgw__hash__bin}
|
|
\input{structpollfd}
|
|
\chapter{File Documentation}
|
|
\input{libwebsockets_8h}
|
|
%--- End generated contents ---
|
|
|
|
% Index
|
|
\backmatter
|
|
\newpage
|
|
\phantomsection
|
|
\clearemptydoublepage
|
|
\addcontentsline{toc}{chapter}{Index}
|
|
\printindex
|
|
|
|
\end{document}
|