WikiTeki /  attachment:documentation.tex de OpenVZ/Formation

   1 %% licence RAFRAB(*)
   2 %%
   3 %% RAFRAB : rien à f**tre, rien à battre, fais ce qu'il te plait dans la vie
   4 %%
   5 
   6 
   7 \documentclass[french]{beamer}
   8 \usepackage{babel}
   9 \usepackage[utf8]{inputenc}
  10 \usetheme{Warsaw}
  11 
  12 \title{Linux : où trouver la documentation ?}
  13 \author{}\institute{Agence universitaire de la Francophonie}
  14 
  15 \begin{document}
  16 
  17 \begin{frame}
  18 \titlepage
  19 \end{frame}
  20 
  21 \section{Généralement}
  22 \frame{\tableofcontents[current]}
  23 
  24 \begin{frame}
  25 Sur le système, les pages de \texttt{man}
  26 \begin{itemize}
  27 \item le format d'une page de manuel : \texttt{NAME}, \texttt{SYNOPSIS}, \texttt{DESCRIPTION},  \texttt{OPTIONS}, \texttt{FILES}, \texttt{SEE ALSO}, \texttt{BUGS}, ...
  28 \item \texttt{man man} : les différentes sections. En cas d'ambiguité, on précise : \texttt{man 1 crontab} ou \texttt{man 5 crontab}
  29 \item \texttt{whatis} et \texttt{apropos}
  30 \item en français : paquet \texttt{manpages-fr}
  31 \item le système \texttt{info}
  32 \end{itemize}
  33 \end{frame}
  34 
  35 \begin{frame}
  36 Sur le web : à boire et à manger !
  37 \begin{itemize}
  38 \item Les grands sites de documentations \textbf{validées} : \url{tldp.org} et \texttt{traduc.org}, \url{linux-france.fr}, ...
  39 \item Les sites «constructeurs» : \url{www.debian.org}, \url{help.ubuntu.com}, ...
  40 \item Les sites des logiciels : \url{www.apache.org}, \url{www.php.net}, ...
  41 \item Attention : aux sites \textit{wiki} publics, aux forums (par mail, sur le web ou sur les news), aux blogs et autres sites personels.
  42 \item Message de la francophonie : préférer la version anglaise, souvent plus à jour que les traductions.
  43 \item Exemples où la prudence est de mise : \texttt{doc.ubuntu-fr.org}, \texttt{www.php.net} et ses forums, les résultats de Google, etc.
  44 \end{itemize}
  45 \end{frame}
  46 
  47 \begin{frame}
  48 Quelques autres sources :
  49 \begin{itemize}
  50 \item Les listes de \textit{diffusion}, notamment les listes d'annonces concernant un logiciel ou un thème (sécurité)
  51 \item Les flux (RSS ou Atom) : c'est du web, on y trouve encore à boire et à manger.
  52 \item Les RFC, les FAQS (\url{http://www.faqs.org}
  53 \item Les livres : chers, très rarement à jour (surtout en cas de traduction), qualité inégale. Quelques collections se détachent du lot.
  54 \item Les canaux IRC, les listes de discussion, les forums USENET...
  55 \end{itemize}
  56 \end{frame}
  57 
  58 \begin{frame}
  59 Au secours je suis perdu, aidez moi !
  60 \begin{itemize}
  61 \item Comment poser les questions de manière intelligente
  62 \item \url{http://www.linux-france.org/article/these/smart-questions/smart-questions-fr.html}
  63 \end{itemize}
  64 \end{frame}
  65 
  66 \section{Documentations orientées Debian} 
  67 \frame{\tableofcontents[current]}
  68 
  69 \begin{frame}
  70 Sur un système Debian : \texttt{/usr/share/doc/\textit{logiciel}}
  71 \begin{itemize}
  72 \item Gros avantage : c'est la documentation de la version installée du logiciel
  73 \item \texttt{README.Debian} : le premier reflexe après avoir installé un paquet
  74 \item \texttt{NEWS.Debian}
  75 \item \texttt{changelog.Debian} 
  76 \item Note : pour lire des fichiers \texttt{.gz}, utiliser \texttt{zless}
  77 \item Note : parfois présence d'un paquet \texttt{\textit{logiciel}-doc}
  78 \end{itemize}
  79 \end{frame}
  80 
  81 \begin{frame}
  82 Les sites web Debian
  83 \begin{itemize}
  84 \item \url{www.debian.org} : une mine d'information
  85 \item \url{packages.debian.org}
  86 \item \url{bugs.debian.org} : suis-je le seul à avoir ce problème ? (Si oui : \texttt{reportbug})
  87 \item \url{security.debian.org} et la liste de diffusion DSA
  88 \item \url{packages.qa.debian.org}
  89 \item \url{help.ubuntu.com} : plus simple d'accès, mais pas tout à fait Debian (il peut y avoir des différences éventuellement subtiles)
  90 \end{itemize}
  91 \end{frame}
  92 
  93 \section{Les docs de l'AUF} 
  94 \frame{\tableofcontents[current]}
  95 
  96 \begin{frame}
  97 \begin{itemize}
  98 \item Un outil public, le wiki des techniciens : \url{http://wiki.auf.org/wikiteki} (et son flux RSS)
  99 \item Outils de communication internes : listes de discussion/diffusion, messagerie instantannée (avec possibilité de conférence), VoIP et visio-conférence, lettres d'information, pauses café, ...
 100 \item Certains outils internes sont accessibles au public par cooptation
 101 \end{itemize}
 102 \end{frame}
 103 
 104 \section{et OpenVZ ?} 
 105 \frame{\tableofcontents[current]}
 106 
 107 \begin{frame}
 108 \begin{itemize}
 109 \item \url{www.openvz.org} : un wiki... donc attention (vérifier les dates)
 110 \item mais : une doc de référence en PDF
 111 \item mais : des pages de man très bien faites (\texttt{vzctl}, \texttt{vps.conf}, ...)
 112 \end{itemize}
 113 \end{frame}
 114 
 115 \end{document}