forked from Anri/cal8tor
better help
This commit is contained in:
parent
f4fae0aa22
commit
ec3509d901
1 changed files with 15 additions and 28 deletions
|
@ -142,44 +142,31 @@ jours en colonnes et les heures en lignes.
|
|||
|
||||
\clearpage
|
||||
\section{Exemple d'utilisation}
|
||||
Voici la commande d'aide du programme :
|
||||
\begin{figure}[h]
|
||||
\begin{minted}[autogobble,fontsize=\footnotesize]{text}
|
||||
Extractor of the calendar of the IT degree of university Paris 8
|
||||
|
||||
Usage: cal8tor [OPTIONS] <CLASS>
|
||||
|
||||
Arguments:
|
||||
<CLASS> The class you want to get the timetable, i.e.: L2-A
|
||||
|
||||
Options:
|
||||
-s, --semester <SEMESTER NUMBER> The semester you want (useful only in 3rd year, 1-2 use letter in class)
|
||||
-e, --export <FILE NAME> Export to iCalendar format (.ics)
|
||||
-c, --cl <CELL LENGTH> Size of cell of the timetable (irrelevant when exporting the timetable) [default: 35]
|
||||
-h, --help Print help information
|
||||
-V, --version Print version information
|
||||
\end{minted}
|
||||
\caption{Affichage de la sortie d'aide
|
||||
(\footnotesize{\texttt{cargo r \dd{}release \dd{} \dd{}help}})}
|
||||
\label{txt:help}
|
||||
\end{figure}
|
||||
|
||||
Pour explication :
|
||||
Voici explication de comment utiliser le programme :
|
||||
\begin{description}
|
||||
\item[\texttt{<CLASS>}] spécifie quelle classe on veut récupérer l'emploi
|
||||
du temps, elle peut être écrite dans plusieurs formats
|
||||
(exemple : \q{L3A} \q{L3-a} \q{l3 a} \q{l3$\cdot$A} etc.)
|
||||
\item[\texttt{-s, \dd{}semester <int>}] est utile uniquement quand la
|
||||
classe n'a pas de groupe, sinon c'est détecté automatiquement
|
||||
\item[\texttt{-c, \dd{}cl <int>}] permet de changer la taille des cellules
|
||||
lorsque l'on affiche l'emploi du temps sur la sortie standard
|
||||
\begin{itemize}
|
||||
\item[$\rightarrow$] \texttt{cargo r \dd{}release \dd{} L3Y}
|
||||
\end{itemize}
|
||||
\item[\texttt{-e, \dd{}export <file>}] permet d'exporter dans un fichier
|
||||
l'emploi du temps (cf. \autoref{txt:l3y-file})
|
||||
\begin{itemize}
|
||||
\item[$\rightarrow$] \texttt{cargo r \dd{}release \dd{} L3Y -e file}
|
||||
\end{itemize}
|
||||
\item[\texttt{-h, \dd{}help}] affiche un message d'aide similaire à ce
|
||||
bloc descriptif
|
||||
\begin{itemize}
|
||||
\item[$\rightarrow$] \texttt{cargo r \dd{}release \dd{} -h}
|
||||
\end{itemize}
|
||||
\end{description}
|
||||
|
||||
\vspace{1em}
|
||||
Par défaut, le programme affiche l'emploi du temps dans la sortie standard
|
||||
(cf. \autoref{fig:l3y-cli}) et ne l'exporte pas dans un fichier.
|
||||
|
||||
\begin{itemize}
|
||||
\item[$\rightarrow$] \texttt{cargo r \dd{}release}
|
||||
\end{itemize}
|
||||
|
||||
\end{document}
|
||||
|
|
Reference in a new issue