1 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 % Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 % Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 % Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 % Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
12 % Copyright (C) 2006 The Rockbox Manual Team
14 % All files in this archive are subject to the GNU Free Documentation License
15 % See the file COPYING-MANUAL in the source tree docs/ directory for full license
18 % Contributors are listed in the file docs/CREDITS-MANUAL
20 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
22 \documentclass[a4paper,
11pt
]{scrreprt
}
23 \usepackage[utf8
]{inputenc}
24 % This manual used to use Palatino as font. This caused issues with small caps
25 % (textsc), so do not use that font as default one anymore.
39 \usepackage[table
]{xcolor
}
41 \input{platform/
\platform.tex
}
44 \newcommand{\playername}{\playerman\
\playerlongtype}
46 \hypersetup{% add some values to the pdf properties
52 pdftitle =
{Rockbox user manual
},
53 pdfauthor =
{The Rockbox Team
},
54 pdfsubject =
{Rockbox user manual for
\playername}
57 \newcommand{\fname}[1]{\texttt{#1}}
58 \newcommand{\tabeltc}[1]{{\centering #1 \par}}
59 \newcommand{\tabelth}[1]{{\centering \textbf{\textit{#1}} \par}}
61 \newcommand{\fixme}[1]{\textbf{\textcolor{red
}{#1}}}
63 % Colors used to typeset table headers and alternating table rows
64 \colorlet{tblhdrbgcolor
}{blue!
30} % Background color for headers
65 \colorlet{tbloddrowbgcolor
}{blue!
10} % Background color for odd rows (headers not included)
66 \colorlet{tblevenrowbgcolor
}{white
} % Background color for even rows (headers not included)
74 \ifpdfoutput{\usepackage{booktabs
}}%
76 \toprule}{}\newcommand{\midrule}{\hline}\newcommand{\bottomrule}{}%
78 \usepackage{longtable
}
85 % pdf output: try pdf first, then png and jpg as file format
86 % html output: try png first, then jpg. Ignore pdf files
87 % this only applies if no file extension is given!
88 \ifpdfoutput{\DeclareGraphicsExtensions{.pdf,.png,.jpg
}}%
89 {\DeclareGraphicsExtensions{.png,.jpg
}}
91 % fancy header style adjustments
94 \fancyhead[L
]{{\nouppercase{\textsc{\leftmark}}}}
95 \fancyhead[R
]{\iffloatpage{}{\thepage}}
96 \fancyfoot[L
]{\textsc{The Rockbox manual
}}
97 \fancyfoot[R
]{\textsc{\playerman{} \playertype}}
98 \fancypagestyle{plain
}{}
100 \renewcommand{\headrulewidth}{\iffloatpage{0pt
}{0.4pt
}}
101 \renewcommand{\footrulewidth}{\iffloatpage{0pt
}{0.4pt
}}
102 \setlength{\headheight}{18.5pt
}
103 \newcounter{example
}[chapter
]
105 %% \newenvironment{example}
106 %% {\stepcounter{example}\paragraph{Example \theexample:}}
112 % found on the internet, posting by Donald Arseneau
113 % I may as well include my robust expandable definions, which can be
114 % used in \edef or \write where the \def would not be executed:
116 % \if\blank --- checks if parameter is blank (Spaces count as blank)
117 % \if\given --- checks if parameter is not blank: like \if\blank{#1}\else
118 % \if\nil --- checks if parameter is null (spaces are NOT null)
119 % use \if\given{ } ... \else ... \fi etc.
121 {\catcode`\!=
8 % funny catcode so ! will be a delimiter
122 \catcode`
\Q=
3 % funny catcode so Q will be a delimiter
123 \long\gdef\given#1{88\fi\Ifbl@nk
#1QQQ
\empty!
}
124 \long\gdef\blank#1{88\fi\Ifbl@nk
#1QQ..!
}% if null or spaces
125 \long\gdef\nil#1{\IfN@Ught
#1*
{#1}!
}% if null
126 \long\gdef\IfN@Ught
#1 #2!
{\blank{#2}}
127 \long\gdef\Ifbl@nk
#1#2Q
#3!
{\ifx#3}% same as above
130 % environment for setting the changelog.
131 \newenvironment{changelog
}%
132 {\renewcommand{\labelitemi}{$
\star$
}\setitemize{noitemsep,topsep=
0pt
}%
137 % add screenshot image.
138 % Usage: \screenshot{filename}{caption}{label}
139 % By using the 'H' (HERE) placement, the screenshots are placed where
141 % Note: use this only for screenshots!
142 % Note: leave caption empty to supress it.
143 \newcommand{\screenshot}[3]{
146 \IfFileExists{#1-
\genericimg-
\specimg.png
}
147 {\includegraphics[width=
\screenshotsize]{#1-
\genericimg-
\specimg.png
}
148 \typeout{Note: device specific image used
}}
149 {\IfFileExists{#1-
\genericimg.png
}
150 {\includegraphics[width=
\screenshotsize]{#1-
\genericimg.png
}}
152 {\includegraphics[width=
\screenshotsize]{#1}
153 \typeout{Warning: deprecated plain image name used
}}%
154 {\typeout{Missing image:
#1 (
\genericimg) (
\specimg)
}%
155 \color{red
}{\textbf{WARNING!
} Image not found
}%
159 \if\blank{#3}\else{\label{#3}}\fi\if\blank{#2}\else{%
165 % command to display a note.
166 % Usage: \note{text of your note}
167 % Note: do NOT use \textbf or similar to emphasize text, use \emph!
169 \newcommand{\note}[1]{
170 \ifinner\else\par\noindent\fi
172 \ifinner#1\else\marginpar{\raisebox{-
6pt
}{\Huge\Writinghand}}#1\par\fi%
174 {\newcommand{\note}[1]{\ifinner\else\par\noindent\fi\textbf{Note:
{} }#1\par}}
176 % command to display a warning.
177 % Usage: \warn{text of your warning}
178 % Note: do NOT use \textbf or similar to emphasize text!
180 \newcommand{\warn}[1]{
181 \ifinner\else\par\noindent\fi
183 \ifinner#1\else\marginpar{\raisebox{-
6pt
}{\Huge\Stopsign}}#1\par\fi%
185 {\newcommand{\warn}[1]{\ifinner\else\par\noindent\fi\textbf{Warning:
{} }#1}}
187 % command to mark a text block as intended especially for blind people
188 % Usage: \blind{text}
190 \newcommand{\blind}[1]{
191 \ifinner\else\par\noindent\fi
192 \ifinner#1\else\marginpar{\raisebox{-
6pt
}{\Huge\ForwardToEnd}}#1\par\fi%
194 {\newcommand{\blind}[1]{\ifinner\else\par\noindent\fi#1}}
196 % make table floats use "H" (as for screenshots) as default positioning
197 \makeatletter\renewcommand{\fps@table
}{H
}\makeatother
198 % change defaults for floats on a page as we have a lot of small images
199 \setcounter{topnumber
}{3} % default: 2
200 \setcounter{bottomnumber
}{2} % default: 1
201 \setcounter{totalnumber
}{5} % default: 3
204 % Environment for typesetting tables in a consistent way. The header has
205 % a darker background; rows are white and light gray (alternating). Top,
206 % middle and bottom rules are automatically set.
210 % #2 -- column specification (as used in the package tabularx)
211 % #3 -- contents of the header row. The number of items must
212 % match the number of specs in #2
213 % #4 -- caption (optional). If used then this must be inside a floating
214 % environment, e.g. table
215 % #5 -- label (optional)
218 % \begin{rbtabular}{0.9\textwidth}{lX}{Col1 & Col2}{}{}
224 \newenvironment{rbtabular
}[5]{%
225 \rowcolors{2}{tbloddrowbgcolor
}{tblevenrowbgcolor
}
226 \expandafter\let\expandafter\SavedEndTab\csname endtabular*
\endcsname
227 \expandafter\renewcommand\expandafter*
\csname endtabular*
\endcsname{%
230 \if\given{#4}\caption{#4}\fi%
231 \if\given{#5}\label{#5}\fi%
235 \tabularx{#1}{#2}\toprule\rowcolor{tblhdrbgcolor
}
244 % command to set the default table heading for button lists
245 \newcommand{\taghead}{\textbf{Tag
} &
\textbf{Description
} \\
\midrule}
247 % environment intended to be used with tag maps (for wps)
248 % usage: \begin{tagmap}{caption}{label} Tag & Description \\ \end{tagmap}
249 % Note: this automatically sets the table lines.
250 % Note: you *need* to terminate the last line with a linebreak \\
251 % Note: you still need to enclose this with \begin{table} / \end{table}
252 % Cheers for the usenet helping me building this up :)
253 \newenvironment{tagmap
}[2]{%
254 \rowcolors{2}{tbloddrowbgcolor
}{tblevenrowbgcolor
}
255 \expandafter\let\expandafter\SavedEndTab\csname endtabular*
\endcsname
256 \expandafter\renewcommand\expandafter*
\csname endtabular*
\endcsname{%
259 \if\given{#1}\caption{#1}\fi%
260 \if\given{#2}\label{#2}\fi%
264 \tabularx{\textwidth}{lX
}\toprule\rowcolor{tblhdrbgcolor
} % here is the table width defined
270 % When creating HTML, use the soul package.
271 % This produces much nicer HTML code (textsc results in each character being
272 % put in a separate <span>).
273 \ifpdfoutput{\newcommand{\caps}[1]{\textsc{#1}}}{\usepackage{soul
}}
274 \newcommand{\setting}[1]{\caps{#1}}
276 \newcommand{\config}[1]{\texttt{#1}}
278 % set link to download server
279 % Usage: \download{bootloader/bootloader-ipodnano.ipod}
281 % "http://download.rockbox.org/bootloader/bootloader-ipodnano.ipod"
282 \newcommand{\download}[1]{\url{http://download.rockbox.org/
#1}}
284 % set link to the wiki.
285 % Usage: \wikilink{WebHome}
286 % with "WebHome" being the wiki page name
287 \newcommand{\wikibaseurl}{http://www.rockbox.org/wiki/
}
288 \ifpdfoutput{\newcommand{\wikiicon}{\Pointinghand}}
289 {\newcommand{\wikiicon}{}}
290 \newcommand{\wikilink}[1]{\wikiicon{}\href{\wikibaseurl#1}{#1}}
291 %\newcommand{\wikilink}[1]{\url{http://www.rockbox.org/wiki/#1}}
293 % define environment "code" based on fancyvrb.
294 % use it to set code the user should type / see on his screen.
295 % Note: the first 4 characters of each line will be stripped,
296 % requiring everything to be indendet by exactly _4_ spaces!
297 % This is intended to make the LaTeX sources more readable.
298 % Note: when using the code environment you need to use optv instead of opt!
299 \DefineVerbatimEnvironment{code
}{Verbatim
}%
300 {framerule=
0.4pt, framesep=
1ex,frame=lines,
%numbers=left,stepnumber=5,%
301 gobble=
4,fontsize=
\footnotesize,xleftmargin=
10pt,xrightmargin=
10pt,
%
302 label=
\textnormal{\textsc{Code
}},
%
306 % define environment "example" based on fancyvrb.
307 % use it to set example code the user should type / see on his screen.
308 % Note: the first 4 characters of each line will be stripped,
309 % requiring everything to be indendet by exactly _4_ spaces!
310 % This is intended to make the LaTeX sources more readable.
311 % Note: when using the example environment you need to use optv instead of opt!
312 \DefineVerbatimEnvironment{example
}{Verbatim
}%
313 {commentchar=!,framerule=
0.4pt, framesep=
1ex,frame=lines,
%
314 gobble=
4,fontsize=
\footnotesize,xleftmargin=
10pt,xrightmargin=
10pt,
%
315 label=
\textnormal{\textsc{Example
}},
%
319 % Use the nopt command to exclude a certain defined feature from a sectio
321 % \nopt{ondio}{This text will be excluded for ondios}
322 \newcommand{\optnvalue}{0}
323 \newcommand{\nopt}[2]{%
324 \renewcommand{\optnvalue}{0}\opt{#1}{\renewcommand{\optnvalue}{1}}%
325 \ifthenelse{\optnvalue >
0}{}{#2}%
328 % Use the reference to handle get a flexible reference command
329 % usage \reference{ref_section}
331 \newcommand{\reference}[1]{%
332 section~
\ref{#1} (page~
\pageref{#1})
%
334 {\newcommand{\reference}[1]{section~
\ref{#1}}}
336 % special HTML output adjustments
337 \ifpdfoutput{}{\setlength{\parindent}{0mm
}}
338 \ifpdfoutput{}{\renewcommand{\Forward}[1]{$
\triangleright$
{}#1}}
340 \newcommand{\btnfnt}[1]{\textbf{#1}}
348 % command to set the default table heading for button lists
349 \newcommand{\btnhead}{\textbf{Key
} \opt{HAVEREMOTEKEYMAP
}{%
350 &
\textbf{Remote Key
}} &
\textbf{Action
} \\
\midrule}
351 % environment intended to be used with button maps
352 % usage: \begin{btnmap}{caption}{label} Button & ButtonAction \\ \end{btnmap}
353 % Note: this automatically sets the table lines.
354 % Note: you *need* to terminate the last line with a linebreak \\
355 % Note: you still need to enclose this with \begin{table} / \end{table}
356 % Cheers for the usenet helping me building this up :)
358 % tabularx is set to be either two or three columns wide depending on whether
359 % HAVEREMOTEKEYMAP is defined in the platform file for the target in question.
360 % If it is, then every button table has three columns of the form
361 % Main Unit Key & Remote Key & Description \\
363 \newenvironment{btnmap
}[2]{%
364 \rowcolors{2}{tbloddrowbgcolor
}{tblevenrowbgcolor
}
365 \expandafter\let\expandafter\SavedEndTab\csname endtabular*
\endcsname
366 \expandafter\renewcommand\expandafter*
\csname endtabular*
\endcsname{%
369 \if\given{#1}\caption{#1}\fi%
370 \if\given{#2}\label{#2}\fi%
374 \opt{HAVEREMOTEKEYMAP
}{
375 % here is the table width defined for 3 columns
376 \tabularx{.95\textwidth}{>
{\raggedright\arraybackslash}p
{.2\textwidth}>
{\raggedright\arraybackslash}p
{.2\textwidth}X
}\toprule\rowcolor{tblhdrbgcolor
}
378 \nopt{HAVEREMOTEKEYMAP
}{
379 % here is the table width defined for 2 columns
380 \tabularx{.75\textwidth}{>
{\raggedright\arraybackslash}p
{.22\textwidth}X
}\toprule\rowcolor{tblhdrbgcolor
}