Commit graph

216 commits

Author SHA1 Message Date
Solomon Peachy
4c745fe8ac xduoox3: A few manual improvements
* Fix a typo in a URL
 * Note how to enter the OF from the bootloader
 * Document how to perform a hard reset

Change-Id: I96d0d64cbd251573e1c5c55657ee5c5db510d9a6
2021-08-22 07:57:24 -04:00
Solomon Peachy
f8bbe3352c rocker: First crack at manual for the AGPTek Rocker
It needs screenshots and slightly better installation instructions

Includes bits shared with other HibyOS platforms

Change-Id: I1c1974143b5badf1aca5c3281556ce553ab1b8a5
2021-07-24 11:16:57 -04:00
Aidan MacDonald
fde6eaa8e1 Add Fiio M3K and Shanling Q1 manuals
Includes installation instructions and a description of Rockbox's
limitations versus the original firmware. Some things are still
missing, notably screenshots for the Q1. The M3K image also needs
to be updated to include the 'select' button.

Change-Id: Ib533206df01925203edeccdd75e1bf22f407e794
2021-07-24 14:07:09 +00:00
Christian Soffke
49c230f630 Manual: fix spelling
Change-Id: Ief54632bd3c6e672e0574226f5d7edf760b43875
2021-03-11 19:43:48 +00:00
Moshe Piekarski
332433eb3d fix a few manual warnings
Change-Id: I4b9bf1e418367b2a420f56ce36f30cb0926e816f
2020-11-22 03:48:28 +00:00
Moshe Piekarski
0aa702836b Manual: remove most HWCODEC artifacts
This causes 3 changes in layout. 2 I can't track down and 1 is better this way.

Change-Id: If4ad5e1d7431b4c2cbaaf9767d78139ef4e2dc44
2020-11-18 14:35:09 +00:00
Solomon Peachy
60f581e8f5 usb: Add ability to prompt user about what to do upon usb insertion
v3: Add in config option
 v4: Bugfixes
 v5: Force a redraw upon exiting
 v6: keypress-in-chargeonly mode enables mass storage (and vice versa)
 v7: Fix bootloader builds
 v8: Update manual, and have bootloader respect keypresses
 v9: Change default to mass storage (ie no change in behavior)

 todo:
  * test-build dx50/dx90
  * Switch from yes/no to proper menu?
  * prevent WPS progress bar from drawing over us

Change-Id: I82e0ccb08497b7a5aa756ce77f1332ee963703a7

...

Change-Id: I7946cf240b18a4fa8ace5e25e1eb6e97b8b12d7c
2020-11-13 16:44:01 -05:00
Solomon Peachy
14c2f55ab3 FS#13239: Fix typo in the xduoo x3 manual
Change-Id: Ib38dcb7dd0ff28ac4789a172c377821447a89d5a
2020-09-10 02:57:20 +00:00
Solomon Peachy
22eb2300b1 manual: Document all mikmod configuration options
Change-Id: I942b3198c720ab74d429f5549f7eae01390c567d
2020-08-24 19:27:23 -04:00
Solomon Peachy
062c597f79 xduoox3: Manual updates and screenshots for a pile of plugins
Change-Id: I5181b38412999c1675535987325a43a48cdde84d
2020-08-24 18:49:22 -04:00
Solomon Peachy
675b22e76b xduoox3: Initial manual
TODO:

 * Screenshots
 * Plugin keymaps

Change-Id: Iaecaa2f585693eb5c2c301bd07aeaa27cdf2588f
2020-08-24 11:58:28 -04:00
Solomon Peachy
092c340a20 [1/4] Remove SH support and all archos targets
This removes all code specific to SH targets

Change-Id: I7980523785d2596e65c06430f4638eec74a06061
2020-07-24 21:20:13 +00:00
Franklin Wei
ca673d7e9f Partially revert the last commit.
The \if->\If replacement is a bit premature for texlive-2019, apparently.

Change-Id: Iab198c2f5e2f00ecdf7e2431e2b77c423e6afc07
2020-06-28 00:08:42 -04:00
Moshe Piekarski
140bf66b90 fix a few manual warnings
Change-Id: I6abcceeb84d70e32be203049950c6fe4711e8df8
2020-06-28 03:41:54 +00:00
Sebastian Leonhardt
a507bb2837 YH8xx,YH9xx: Keymap improvement
The main "innovation" in this patch are two "virtual buttons"
for the record switch on YH92x targets. When the switch state
changes, a single BUTTON_REC_SW_ON or .._OFF button event will
be generated. Thus keymap code can react on switching, but
not on the actual state of the switch.

Wherever sensible, the following user scheme is applied:
- use PLAY as confirm button
- use REW button or Long REW to exit
- use REC (YH820) or FFWD (YH92X) as modifier key for button combos

Change-Id: Ic8d1db9cc6869daed8dda98990dfdf7f6fd5d5a1
2015-11-15 23:46:39 +01:00
Szymon Dziok
e7f113e1bb Manual for the Samsung YH820.
Change-Id: I1c760b4846963f39b9df60413ffbb9f95dc0e0fb
2014-10-22 09:59:26 +02:00
Szymon Dziok
a8b5589523 Manual for the Samsung YH920/YH925.
Change-Id: I2db0023cae585e9c9517da9ed2e9de6195081ce2
2014-10-22 09:59:26 +02:00
Rafaël Carré
0584edcdb4 Update manual for Clip Zip
Change-Id: I6c2dd691f8d42d041e9ff7718b4cc641e557bf5b
2013-02-02 13:53:30 +01:00
Marianne Arnold
5f2618c363 Manual: Include the iaudio remote graphic in its manual again.
Commit bb24ac8c27 replaced the
\opt{iaudiom3,iriverh100} with \opt{remote} which isn't true in the
Iaudio M3 case as this feature is dependent on HAVE_REMOTE_LCD and
the M3 uses this screen as main lcd so doesn't define it. Use the manual
HAVEREMOTEKEYMAP for now as I didn't find a suitable other define yet.

Change-Id: I58b2abd2f7cae1a821cea297a2b4c002a3420493
2012-05-20 18:08:30 +02:00
Jean-Louis Biasini
6637e24aed Update Fuze+ manual (main files) FS#12492
- this patch add all general sections of the manual for the fuze+
     - also correct some typos

Change-Id: Idd28675f48c0d01079d8fa01d68d3238ad2a54ce
Reviewed-on: http://gerrit.rockbox.org/116
Reviewed-by: Dominik Riebeling <Dominik.Riebeling@gmail.com>
2012-05-01 20:19:25 +02:00
Dominik Riebeling
47e30b8cdc Update manual for boot behaviour on clip+, clipv2 and fuzev2.
The bootloader doesn't boot into the Original Firmware anymore since a while.
Remove the claim that Rockbox will always boot the OF on USB, and add a note
about older builds not providing USB support.

Change-Id: I44f37eeb849b522a2024eb26cee064e848bc4d17
2012-03-12 22:48:40 +01:00
Marcin Bukat
4bbc9f68ea MPIOs: manual work
Change-Id: Ief46eabf3611d6d21594f52f73292f2be5831b87
2012-02-02 14:55:51 +01:00
Dominik Riebeling
bb24ac8c27 Manual: don't break on missing player image.
As done with the screenshots display an error notice when the main image is
missing. Same is done for the remote image for targets that do have a remote.

\IfFileExists requires to use the full filename, not the stem as
\includegraphics accepts happily, so 36489d9 actually broke the main image for
all players.
2012-01-14 20:57:19 +01:00
Rafaël Carré
36489d9aa0 manual: don't error out if front image is missing 2012-01-14 14:13:37 -05:00
Frank Gevaerts
0265c8be0f USB chargung now works the normal way on AMSv2, so remove the hack that treated it differently. Also fix the fuze+ workaround for the lack of ActionStdUsbCharge there
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31578 a1c6a512-1295-4272-9138-f99709370657
2012-01-04 12:57:18 +00:00
Dominik Riebeling
607b384a2a Manual: make Fuze+ manual build.
Add missing keys as \fixme{} and update some opts for text using keys we don't
have on the Fuze+.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31512 a1c6a512-1295-4272-9138-f99709370657
2012-01-01 10:16:47 +00:00
Alex Parker
8355ace582 Manual: try to make it clearer that it is NOT recommended to put music in /.rockbox
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30294 a1c6a512-1295-4272-9138-f99709370657
2011-08-14 10:25:03 +00:00
Michael Giacomelli
1b2ab0770c Fix broken merge of my previous USB changes in the manual.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30178 a1c6a512-1295-4272-9138-f99709370657
2011-07-20 14:13:09 +00:00
Michael Giacomelli
ded03f43f2 Add back mention that rockbox will boot into the OF when powered by USB because the AMSv2 devices don't support USB yet. This used to be there but was mistakenly removed during recent edits.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@30174 a1c6a512-1295-4272-9138-f99709370657
2011-07-20 00:27:18 +00:00
Dominik Riebeling
58995c1e2f Fix a typo that made a macro show up as text. Thanks to fml for noting.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29893 a1c6a512-1295-4272-9138-f99709370657
2011-05-17 06:11:28 +00:00
Michael Giacomelli
84b4c46d74 Enter USB charging mode on devices that support it if any key is held down during USB insert (except on Archos where certain keys need to be avoided and players like the iRiver H1x0 which do not charge over USB and the iAudios/AMSv2 which do not yet support USB fully). Update the manual to explain the new behavior.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29889 a1c6a512-1295-4272-9138-f99709370657
2011-05-16 20:27:14 +00:00
Michael Hohmuth
9f32eb6f0d FS#12102 - Manual, "Quick Start" section for AMSv2 players: Clarifies
how USB charging is handled.  Thanks to Justin Hannigan!

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29860 a1c6a512-1295-4272-9138-f99709370657
2011-05-12 06:43:57 +00:00
Marianne Arnold
b43b4936a1 Pick up the target rename completion in the manual started in r27823 ... this time taking care of the Iriver targets. This fixes a few issues with wrongly in- or excluded parts (e.g. pacbox missing from the H100 manual, invadrox wrongly included in the small H10 manual as the plugin's main.tex already used the new names without making sure they are there). If possible replace 'target name' \opts with sensible feature \opts. Fix small mistakes and break too long lines discovered along the way.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@29075 a1c6a512-1295-4272-9138-f99709370657
2011-01-17 18:30:18 +00:00
Robert Menes
b1a1831a17 Reword the blind description for the MPIO HD200 manual
to fix some typos and grammar.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28983 a1c6a512-1295-4272-9138-f99709370657
2011-01-07 04:54:15 +00:00
Alex Parker
8d849723f7 Manual: change wording slightly in the USB charging section.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28849 a1c6a512-1295-4272-9138-f99709370657
2010-12-18 19:07:06 +00:00
Marcin Bukat
a434a0de5c MPIO HD200 manual - tex files
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28544 a1c6a512-1295-4272-9138-f99709370657
2010-11-09 22:10:38 +00:00
Marianne Arnold
6ee3c036db Manual: add drawings of the H100 remote with button labels to the player images and use it in the 'Quick Start' chapter (below the main player drawing) to explain the button names which were already used in the description.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28393 a1c6a512-1295-4272-9138-f99709370657
2010-10-30 11:17:04 +00:00
Robert Menes
03f6c7a4e7 The c200's blind description also applies to the c200
v2, so add that to the c200v2 manual.


git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28315 a1c6a512-1295-4272-9138-f99709370657
2010-10-20 17:00:58 +00:00
Alex Parker
34c4c44c5d Manual: Clarify that the player must be running to charge/power over USB. Closes bug FS#11504.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28099 a1c6a512-1295-4272-9138-f99709370657
2010-09-17 19:13:26 +00:00
Rafaël Carré
cb435ab5c1 manual: the AMSv1 don't run OF if powered by USB
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28002 a1c6a512-1295-4272-9138-f99709370657
2010-09-06 05:24:16 +00:00
Marianne Arnold
5b47b89d16 First step of completing the target rename in the manual. Some target specific options were already renamed in the rest of the source (e.g. see r23883) but not where they are actually set - in the platform files - leading to parts included or excluded incorrectly. The problem exists for more targets, this commit deals with the supported Iaudios first. Rename 'x5' to 'iaudiox5' (do the same for 'm5' and 'm3'), fix small errors or add missing info related to them along the way, use more appropriate options and simplify code a bit where possible.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27823 a1c6a512-1295-4272-9138-f99709370657
2010-08-16 09:43:48 +00:00
Marianne Arnold
c4bdf20197 Manual: some cosmetic changes in phrasing as well as code... fix typos and RAS syndrome, correct use of dap{} and {daps}.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27809 a1c6a512-1295-4272-9138-f99709370657
2010-08-14 10:30:42 +00:00
Alex Parker
9dd5f75966 Clarify where music can be put on the player.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27352 a1c6a512-1295-4272-9138-f99709370657
2010-07-08 20:10:39 +00:00
Marianne Arnold
bf83ac6240 Add platform and keymap files and basic descriptions about installing Rockbox etc. for an Onda VX777 manual. Author: Giovanni Zilli. Flyspray: FS#11437.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27279 a1c6a512-1295-4272-9138-f99709370657
2010-07-04 13:28:20 +00:00
Alexander Levin
942e427ef0 Simplify the 'blind' macro and imrove spacing where it's used
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27166 a1c6a512-1295-4272-9138-f99709370657
2010-06-28 22:39:45 +00:00
Alexander Levin
9b8d53adfe Do not produce an extra space for non-albumart manuals
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@27064 a1c6a512-1295-4272-9138-f99709370657
2010-06-22 20:33:49 +00:00
Alexander Levin
5f87334d4f Do not produce additional space after 'to the picture above'
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26901 a1c6a512-1295-4272-9138-f99709370657
2010-06-17 22:12:11 +00:00
Marianne Arnold
8c8b0b37c2 Enable the IAUDIO_RC_PAD macro for the M5 and X5 too, so that tables using this instead of the platform files' actions can be filled too. Complete the table in the quick start section mentioning how to start and shut down Rockbox for the Iaudio remote while at it.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26805 a1c6a512-1295-4272-9138-f99709370657
2010-06-11 22:45:18 +00:00
Rafaël Carré
5d92ae4eb6 manual: change all references to 'headphone jack' into more correct 'headphone socket'
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26213 a1c6a512-1295-4272-9138-f99709370657
2010-05-20 19:58:45 +00:00
Rafaël Carré
f39ef96676 Clip+: add description of buttons for blind users
Also change 'clip' options into correct 'clipv1'

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@26212 a1c6a512-1295-4272-9138-f99709370657
2010-05-20 19:53:44 +00:00