2
0
mirror of https://github.com/koreader/koreader synced 2024-11-02 15:40:16 +00:00
koreader/platform/linux/koreader.1
Martín Fernández 2c6808ba78
Add generic Linux package (#9351)
Relates to https://github.com/koreader/koreader/issues/9268
Requires https://github.com/koreader/koreader-base/pull/1504

Usage: 
- `kodev release linux` for native package (same arch as host)
- `LINUX_ARCH=arm release linux` for armhf on a x86_64 host.
- `LINUX_ARCH=arm64 release linux` for arm64 on a x86_64 host.

It produces a `koreader-linux-$ARCH-$VERSION.tar.xz` archive, where $ARCH follows `uname -m` convention {x86_64, armv7l, aarch64}

To generate the debian package from the generic archive the following command is required

`./platform/linux/do_debian_package.sh path_to.tar.xz`
2024-05-13 12:11:11 +02:00

42 lines
870 B
Groff

.TH KOReader 1 "May 4, 2020"
.SH NAME
koreader \- document viewer
.SH SYNOPSIS
.B koreader
.RI [-dvp]
.RI [file]
.SH DESCRIPTION
.B KOReader
is a document viewer primarily aimed at e-ink readers. This manual page documents briefly its desktop usage.
.SH OPTIONS
Call
.B KOReader
followed by a file to open it directly. Supported document formats include PDF, DjVu, XPS, CBZ, FB2, PDB, TXT, HTML, RTF, CHM, EPUB, DOC, MOBI, and ZIP
.B files.
If no file is passed
.B KOReader
will start using user settings among a file manager (default), a history and the last document opened.
A list of
.BI flags
and their descriptions:
.PP
.B -d start in debug mode
.PP
.B -v debug in verbose mode
.PP
.B -p enable Lua code profiling
.SH SETTINGS
User settings are stored in ~/.config/koreader.
.SH SEE ALSO
Online documentation: https://github.com/koreader/koreader/wiki
.PP