Porting PicoTCP WIP
This commit is contained in:
113
kernel/picotcp/docs/user_manual/user_doc.tex
Normal file
113
kernel/picotcp/docs/user_manual/user_doc.tex
Normal file
@ -0,0 +1,113 @@
|
||||
% Altran NV
|
||||
%
|
||||
% PicoTCP User Documentation main file
|
||||
% ====================================
|
||||
|
||||
%\documentclass[11pt, a4paper, openright]{paper}
|
||||
|
||||
|
||||
\input{layout1}
|
||||
|
||||
% TEMPS
|
||||
|
||||
%\usepackage{tikz}
|
||||
%\usepackage[latin1]{inputenc}
|
||||
%\usepackage{graphicx}
|
||||
%\usepackage[hang,flushmargin]{footmisc}
|
||||
%\usepackage{pdfpages}
|
||||
%\usepackage{tabularx}
|
||||
%\usepackage{lscape}
|
||||
%\usepackage{longtable}
|
||||
%\usepackage{verbatim}
|
||||
%\usepackage{moreverb}
|
||||
%\usepackage{listings}
|
||||
%\usepackage{draftcopy}
|
||||
%\usepackage{hyperref}
|
||||
\usepackage{longtable}
|
||||
|
||||
%% to print watermark
|
||||
% \usepackage{draftwatermark}
|
||||
% \SetWatermarkText{Altran ISY Confidential}
|
||||
% \SetWatermarkScale{3}
|
||||
% \SetWatermarkLightness{0.9}
|
||||
|
||||
% to adjust the space between titles and text
|
||||
\usepackage[compact]{titlesec}
|
||||
\titlespacing{\section}{0pt}{*5}{*2}
|
||||
\titlespacing{\subsection}{0pt}{*4}{*1}
|
||||
\titlespacing{\subsubsection}{0pt}{*1}{*0}
|
||||
|
||||
% to minimize space between list items
|
||||
\usepackage{enumitem}
|
||||
|
||||
% To use hyperlinks
|
||||
\usepackage{hyperref}
|
||||
% limit toc depth until sections
|
||||
\setcounter{tocdepth}{1}
|
||||
|
||||
|
||||
\begin{document}
|
||||
|
||||
\title{picoTCP User Documentation}
|
||||
\author{Copyright \copyright 2017 Altran Belgium NV. All right reserved.}
|
||||
\maketitle
|
||||
\date{\today}
|
||||
\maketitle
|
||||
|
||||
\thispagestyle{empty}
|
||||
|
||||
Disclaimer
|
||||
This document is distributed under the terms of Creative Commons CC BY-ND 3.0.
|
||||
You are free to share unmodified copies of this document, as long as the copyright
|
||||
statement is kept. Click \href{http://creativecommons.org/licenses/by-nd/3.0/} {here} to view the full license text.
|
||||
|
||||
|
||||
\pagenumbering{arabic}
|
||||
|
||||
\selectlanguage{english}
|
||||
|
||||
\tableofcontents
|
||||
|
||||
%\chapter{Introduction}
|
||||
%\label{chap:intro}
|
||||
%\input{chap_intro}
|
||||
|
||||
\chapter{Overview}
|
||||
\label{chap:overview}
|
||||
\input{chap_overview}
|
||||
|
||||
|
||||
\chapter{API Documentation}
|
||||
\label{chap:api_doc}
|
||||
The following sections will describe the API for picoTCP.
|
||||
\input{chap_api_ipv4}
|
||||
\input{chap_api_ipv6}
|
||||
\input{chap_api_sock}
|
||||
\input{chap_api_dhcp_c}
|
||||
\input{chap_api_dhcp_d}
|
||||
\input{chap_api_dns_c}
|
||||
\input{chap_api_mdns}
|
||||
\input{chap_api_dns_sd}
|
||||
\input{chap_api_sntp_c}
|
||||
\input{chap_api_igmp}
|
||||
\input{chap_api_mld}
|
||||
\input{chap_api_ipfilter}
|
||||
\input{chap_api_slaacv4}
|
||||
\input{chap_api_tftp}
|
||||
\input{chap_api_ppp}
|
||||
\input{chap_api_olsr}
|
||||
\input{chap_api_aodv}
|
||||
|
||||
|
||||
\appendix
|
||||
|
||||
% Do not include license
|
||||
%\chapter{License}
|
||||
%\label{chap:license}
|
||||
%\input{chap_license}
|
||||
|
||||
\chapter{Supported RFCs}
|
||||
\label{chap:rfcs}
|
||||
\input{chap_rfcs}
|
||||
|
||||
\end{document}
|
||||
Reference in New Issue
Block a user