OpenInkpot 0.1 Users' Guide

Information about supported hardware and possible installation methods is described in installation guide.

General operation

Navigation in bookshelf

Use numeric keys to activate the item on screen (to open the book or descend into directory).

Use Ok key to open the main menu.

Use <- key to move to parent directory.

SD and internal memory

To switch between internal memory (rootfs, not the partition in internal memory used by Hanlin firmware) and SD card use the "Go to" menu.

To activate this menu, press Menu->"Go to" in bookshelf.

Reboot or shutdown

Press Menu->Scripts->Reboot V3 / Shutdown V3.

Deleting, copying or moving books

This is available from the context menus.

To open context menu, press + and then number of the book. You'll see the options: delete the book, mark it for copying (copy) or mark it for moving (cut).

To copy/move selected book, navigate to destination directory, open global menu and select "edit -> paste".

Only single file can be moved/copied at the time.

Bookshelf

</>	back/forward page
1-8	open Nth file / go to the Nth directory
9/0	back/forward page
OK	open main menu
+	context menu (pressing + then 1 opens context menu for first file on screen, + then 2 for second, etc.)
<-	exit menu or go to parent directory if no menu is open

Book reader

</>	back/forward page
1	move back
2	go to page...
3	toggle status line
4/5	back/forward section
6	cycle through the footnotes on the current page
7	table of contents
8	hyperlink navigation mode / jump to the highlighted hyperlink
9/0	back/forward page
+/-	change font size
<-	exit to bookshelf
OK	settings

Advanced features

SSH access

See the Connect via SSH access.

Customization

TBD

Bookshelf themes

TBD

Bug reporting and feature requests

If you've found a bug or have a feature request, then please do the following:

1. Discuss the issue in IRC
2. If developers say that it is a new issue, then file a ticket.

Contributing