summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorMartin Arver <martin.arver@gmail.com>2006-03-16 11:00:29 +0000
committerMartin Arver <martin.arver@gmail.com>2006-03-16 11:00:29 +0000
commit42257940fb69f3cc8e552bcafe8a27ce1696b708 (patch)
tree8038456101bb9152daf96bfcee5e6d0f0807079f /manual
parent9dae78e4816d4631dacc2f357011b3f429e00333 (diff)
downloadrockbox-42257940fb69f3cc8e552bcafe8a27ce1696b708.tar.gz
rockbox-42257940fb69f3cc8e552bcafe8a27ce1696b708.tar.bz2
rockbox-42257940fb69f3cc8e552bcafe8a27ce1696b708.zip
Adds feature specific options to the platforms. It is now possible to include a section by for instance \opt{HAVE_LCD_BITMAP}{...} for targets with bitmap displays.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@9057 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/Makefile21
-rw-r--r--manual/getting_started/main.tex41
-rw-r--r--manual/platform/h1xx.tex3
-rw-r--r--manual/platform/h300.tex4
-rw-r--r--manual/platform/ipodcolor.tex2
-rw-r--r--manual/platform/ipodnano.tex2
-rw-r--r--manual/platform/ipodvideo.tex2
-rw-r--r--manual/platform/ondio.tex4
-rw-r--r--manual/platform/recorder.tex3
-rw-r--r--manual/platform/recorderv2fm.tex4
10 files changed, 38 insertions, 48 deletions
diff --git a/manual/Makefile b/manual/Makefile
index cc30a744b3..43ba4a65a7 100644
--- a/manual/Makefile
+++ b/manual/Makefile
@@ -1,17 +1,10 @@
-.PHONY: all buildmanual clean
+DOCUMENT := rockbox-build
+LATEX := pdflatex
+include LaTeX.Rules
+GRAPHIC_FILES:=`find . -name \*.jpg \*.jpeg`
-all: rockbox-build.tex
+.PHONY: all cleaner buildmanual output
-rockbox-build.tex: rockbox.tex
- @if [ "$(OBJDIR)" = "" ]; then echo Run make in you build diriectory!; false; fi
- @mkdir -p $(OBJDIR)
- @cp -R * $(OBJDIR)
- @echo "\newcommand{\platform}{${ARCHOS}}" > $(OBJDIR)/rockbox-build.tex
- @echo "\newcommand{\buildversion}{$(VERSION)}" >> $(OBJDIR)/rockbox-build.tex
- @echo "\input{rockbox.tex}" >> $(OBJDIR)/rockbox-build.tex
- @mv $(OBJDIR)/Makefile.pdflatex $(OBJDIR)/Makefile
- make -C $(OBJDIR)
+buildmanual: rockbox-build.tex
+ @cp $(OBJDIR)/rockbox-build.pdf $(OBJDIR)/../rockbox-$(ARCHOS)-$(VERSION).pdf
-clean:
- @if [ "$(OBJDIR)" == "" ]; then echo Run make in you build diriectory!; false; fi
- @rm -rf $(OBJDIR)/manual $(OBJDIR)/*.pdf
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex
index b30b9484de..2f3476f74c 100644
--- a/manual/getting_started/main.tex
+++ b/manual/getting_started/main.tex
@@ -67,48 +67,21 @@ computer via USB as described in the manual that came with your \playername. On
Windows, the \playername\ drive will appear as a drive letter in your
``My Computer'' folder. Take the file that you downloaded above, and unpack
its contents to your \playername\ drive. You can do this using a program such
-as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
-
-You will need to unpack all of the files in the archive onto your hard
-disk. If this has been done correctly, you will have a file called
-\opt{h1xx,h300}{\fname{rockbox.iriver}}
-\opt{ipodcolor,ipodnano}{\fname{rockbox.ipod?}}
-\opt{ondio}{\fname{rockbox.ondio?}}
-\opt{player}{\fname{archos.mod}}
-\opt{recorder,recorderv2fm}{\fname{ajbrec.ajz}}
-in the main folder of your \playername\ drive, and also a folder called
-/\fname{.rockbox}, which contains a number of system files used by the
-software.
+as \url{http://www.info-zip.org/} or \url{http://www.winzip.org/}.
+
+You will need to unpack all of the files in the archive onto your hard disk. If this has been done correctly, you will have a file called \opt{h1xx,h300}{\fname{rockbox.iriver}}\opt{ipodcolor,ipodnano}{\fname{rockbox.ipod?}}\opt{ondio}{\fname{rockbox.ondio?}}\opt{player}{\fname{archos.mod}}\opt{recorder,recorderv2fm}{\fname{ajbrec.ajz}} in the main folder of your \playername\ drive, and also a folder called /\fname{.rockbox}, which contains a number of system files used by the software.
\section{Enabling Speech Support (optional)}
-If you wish to use speech support you will also need a language file,
-available from
-\url{http://www.rockbox.org/twiki/bin/view/Main/VoiceFiles/}.
- For the English language, the file is called \fname{english.voice}.
-When it has been downloaded, unpack this file and copy it into the
-\fname{lang} folder which is inside the /\fname{.rockbox} folder on
-your Jukebox. Voice menus are turned on by default. See page
-\pageref{ref:Voiceconfiguration} for details on voice settings.
+If you wish to use speech support you will also need a language file, available from \url{http://www.rockbox.org/twiki/bin/view/Main/VoiceFiles/}. For the English language, the file is called \fname{english.voice}. When it has been downloaded, unpack this file and copy it into the \fname{lang} folder which is inside the /\fname{.rockbox} folder on your Jukebox. Voice menus are turned on by default. See page \pageref{ref:Voiceconfiguration} for details on voice settings.
\section{Running Rockbox}
-Remove your Jukebox from the computer's USB port.
-Unplug any connected power supply and turn the unit off. When you next
-turn the unit on, the Jukebox firmware will start to load, and then it
-will load Rockbox for you. When you see the Rockbox splash screen,
-Rockbox is loaded and ready for use.
+Remove your Jukebox from the computer's USB port. Unplug any connected power supply and turn the unit off. When you next turn the unit on, the Jukebox firmware will start to load, and then it will load Rockbox for you. When you see the Rockbox splash screen, Rockbox is loaded and ready for use.
\section{Uninstalling Rockbox}
If you would like to go back to using the original \playername\ software, then
-connect the \playername\ to your computer, and delete the
-\opt{h1xx,h300}{\fname{rockbox.iriver}}
-\opt{ipodcolor,ipodnano}{\fname{rockbox.ipod?}}
-\opt{ondio}{\fname{rockbox.ondio?}}
-\opt{player}{\fname{archos.mod}}
-\opt{recorder,recorderv2fm}{\fname{ajbrec.ajz}} file.
-If you wish to clean up your disk, you may also wish to delete the
-\fname{.rockbox} folder and its contents. Turn the \playername\ off and on and
-the normal \playername\ software will load.
+connect the \playername\ to your computer, and delete the \opt{h1xx,h300}{\fname{rockbox.iriver}}\opt{ipodcolor,ipodnano}{\fname{rockbox.ipod?}}\opt{ondio}{\fname{rockbox.ondio?}}\opt{player}{\fname{archos.mod}}\opt{recorder,recorderv2fm}{\fname{ajbrec.ajz}} file.
+If you wish to clean up your disk, you may also wish to delete the \fname{.rockbox} folder and its contents. Turn the \playername\ off and on and the normal \playername\ software will load.
diff --git a/manual/platform/h1xx.tex b/manual/platform/h1xx.tex
index 76f4f808b6..7e16ce85f5 100644
--- a/manual/platform/h1xx.tex
+++ b/manual/platform/h1xx.tex
@@ -1,4 +1,7 @@
\def\UseOption{h1xx}
+\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_RECORDING}
+\edef\UseOption{\UseOption,CONFIG_TUNER}
\newcommand{\playerman}{iRiver}
\newcommand{\playertype}{H1xx}
diff --git a/manual/platform/h300.tex b/manual/platform/h300.tex
index ddeb9488ab..469c34f12b 100644
--- a/manual/platform/h300.tex
+++ b/manual/platform/h300.tex
@@ -1,4 +1,8 @@
\def\UseOption{h300}
+\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_RECORDING}
+\edef\UseOption{\UseOption,CONFIG_TUNER}
+\edef\UseOption{\UseOption,CONFIG_RTC}
\newcommand{\playerman}{iRiver}
\newcommand{\playertype}{H3xx}
diff --git a/manual/platform/ipodcolor.tex b/manual/platform/ipodcolor.tex
index cd4e609081..3813089341 100644
--- a/manual/platform/ipodcolor.tex
+++ b/manual/platform/ipodcolor.tex
@@ -1,4 +1,6 @@
\def\UseOption{ipodcolor}
+\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,CONFIG_RTC}
\newcommand{\playerman}{Apple}
\newcommand{\playertype}{iPod Color}
diff --git a/manual/platform/ipodnano.tex b/manual/platform/ipodnano.tex
index 5f75ea23b0..6ccecbcc54 100644
--- a/manual/platform/ipodnano.tex
+++ b/manual/platform/ipodnano.tex
@@ -1,4 +1,6 @@
\def\UseOption{ipodnano}
+\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,CONFIG_RTC}
\newcommand{\playerman}{Apple}
\newcommand{\playertype}{iPod Nano}
diff --git a/manual/platform/ipodvideo.tex b/manual/platform/ipodvideo.tex
index c259683fe1..d29fb85105 100644
--- a/manual/platform/ipodvideo.tex
+++ b/manual/platform/ipodvideo.tex
@@ -1,4 +1,6 @@
\def\UseOption{ipodvideo}
+\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,CONFIG_RTC}
\newcommand{\playerman}{Apple}
\newcommand{\playertype}{iPod Video}
diff --git a/manual/platform/ondio.tex b/manual/platform/ondio.tex
index e52a1dda12..bb33e3eb4f 100644
--- a/manual/platform/ondio.tex
+++ b/manual/platform/ondio.tex
@@ -1,4 +1,8 @@
+%platform file for the Ondio SP,FM
\def\UseOption{ondio}
+\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_RECORDING}
+\edef\UseOption{\UseOption,CONFIG_TUNER}
\newcommand{\playerman}{Archos}
\newcommand{\playertype}{Archos Ondio}
diff --git a/manual/platform/recorder.tex b/manual/platform/recorder.tex
index 733a8d9792..5b30c24646 100644
--- a/manual/platform/recorder.tex
+++ b/manual/platform/recorder.tex
@@ -1,4 +1,7 @@
\def\UseOption{recorder}
+\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_RECORDING}
+\edef\UseOption{\UseOption,CONFIG_RTC}
\newcommand{\playerman}{Archos}
\newcommand{\playertype}{Recorder}
diff --git a/manual/platform/recorderv2fm.tex b/manual/platform/recorderv2fm.tex
index 21801aeaac..f650cb4c8b 100644
--- a/manual/platform/recorderv2fm.tex
+++ b/manual/platform/recorderv2fm.tex
@@ -1,4 +1,8 @@
\def\UseOption{recorderv2fm}
+\edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
+\edef\UseOption{\UseOption,HAVE_RECORDING}
+\edef\UseOption{\UseOption,CONFIG_TUNER}
+\edef\UseOption{\UseOption,CONFIG_RTC}
\newcommand{\playerman}{Archos}
\newcommand{\playertype}{Recorder V2/FM}