auto: Keyman for linux help deployment

products/linux/20.0/about/history.md

@@ -0,0 +1,9 @@
+---
+title: Version History of Keyman for Linux
+---
+
+A frequent updated changelog for Keyman is kept at [help.keyman.com/version-history](https://help.keyman.com/version-history) on the Keyman Help website.
+
+## Related Topics
+
+* [What's New](whatsnew)

products/linux/20.0/about/index.md

@@ -0,0 +1,7 @@
+---
+title: About Keyman for Linux
+---
+
+* [Welcome to Keyman](welcome)
+* [What's New](whatsnew)
+* [Version History](history)

products/linux/20.0/about/welcome.md

@@ -0,0 +1,11 @@
+---
+title: Welcome to Keyman for Linux
+---
+
+Thank you for installing Keyman for Linux. Whether you're a new or returning user, we believe you will appreciate the significant enhancements in this latest version of Keyman for Linux.
+
+## What is Keyman for Linux?
+
+Keyman for Linux makes it possible to type in over 2,000 languages in any Linux application.
+
+[Click here](../start/) to get started.

products/linux/20.0/about/whatsnew.md

@@ -0,0 +1,5 @@
+---
+title: What's New in Keyman 20.0 for Linux
+---
+
+Here are some of the new features we have added to Keyman for Linux 20.0:

products/linux/20.0/common/index.md

@@ -0,0 +1,87 @@
+---
+title: Keyman for Linux Common Questions
+---
+
+See also [Knowledge Base articles](https://help.keyman.com/knowledge-base/).
+
+## Q. How do I install Keyman for Linux?
+
+**A.** In Ubuntu and Wasta-Linux, Keyman for Linux can be installed via launchpad:
+
+```bash
+sudo add-apt-repository ppa:keymanapp/keyman
+sudo apt-get update
+sudo apt-get upgrade
+sudo apt-get install keyman onboard-keyman
+```
+
+A possibly older version of Keyman for Linux packages is also available in
+any current Debian at:
+[https://packages.debian.org/keyman](https://packages.debian.org/keyman)
+
+**Note** Versions before Keyman 18 required a patched version of ibus in order
+to fully work. Patched versions of ibus were available in the above mentioned
+launchpad repository and had the string `sil` in the package version number.
+Keyman 18+ no longer requires a patched version of ibus.
+
+## Q. How do I install a Keyman keyboard?
+
+**A.** Follow this [guide](../start/installing-keyboard) for installing Keyman keyboards.
+
+## Q. What's the relationship between Keyman for Linux and KMFL?
+
+**A.** KMFL is no longer actively developed and no longer distributed with
+Keyman 17.
+
+KMFL was developed as a black-box clone of Keyman for Windows years ago; after
+Keyman was released as open source it became possible to share the
+code base between Windows and Linux. Keyman for Linux is the long-term
+supported solution.
+
+## Q. If I already had KMFL installed, how can I uninstall KMFL before installing Keyman?
+
+**A.** It is good to remove any keyboards from ibus e.g. KMFL keyboards before you remove KMFL.
+Then, to remove KMFL:
+
+```bash
+sudo dpkg --purge ibus-kmfl libkmfl
+```
+
+## Q. How do I display the On-screen Keyboard (OSK)?
+
+**A.** From the launcher, enter `onboard`
+
+![](../linux_images/onboard.png "Onboard")
+
+Unfortunately `onbboard` only works with X11, not with Wayland. Currently there's
+no on-screen keyboard for Wayland that works with Keyman.
+
+## Q. What Linux distros will Keyman work with?
+
+**A.** Keyman runs on Debian, Ubuntu, Wasta Linux and can be compiled to run
+from source in most distributions.
+
+**Note:** Ubuntu versions before Ubuntu 22.04 LTS are no longer supported with
+Keyman 18. If you are still running an older version and require Keyman you'll
+have to install an older Keyman version.
+
+## Q. Will my existing Windows Keyman keyboard work with Keyman for Linux?
+
+**A.** Most keyboards will work without change. A small subset of keyboards
+require features which are not yet available in Keyman for Linux. These
+features will be progressively implemented.
+
+## Q. How can I disable automatically reporting errors?
+
+**A.** If Keyman crashes, it will automatically send a report to the development
+team. This report is anonymous and contains only technical details relating to
+the crash. It does not include keystroke data or personally identifying data. If
+you don't want these automatic error reports to be sent you can disable the
+checkbox in the Options in Keyman Configuration, or you can set the
+environment variable `KEYMAN_NOSENTRY` and start `km-config` from
+the command line:
+
+```bash
+export KEYMAN_NOSENTRY=1
+km-config
+```

products/linux/20.0/index.md

@@ -0,0 +1,25 @@
+---
+title: Keyman for Linux 20.0 Help
+---
+
+Need help using Keyman for Linux? In time, this product documentation will grow and explain frequently asked questions.
+
+## [About Keyman for Linux](about/)
+
+* [Welcome to Keyman](about/welcome)
+* [What's New](about/whatsnew)
+* [Version History](about/history)
+
+## [Getting Started](start/)
+
+* [Installing a keyboard](start/installing-keyboard)
+
+## [Common Questions](common/)
+
+## Ask for Help
+
+[Ask other users in the SIL Keyman Community](https://community.software.sil.org/c/keyman)
+
+## Help Topics
+
+* [Reference](reference/)

products/linux/20.0/reference/index.md

@@ -0,0 +1,25 @@
+---
+title: Keyman 18.0 for Linux Reference
+---
+
+## Keyman 18.0 for Linux Overview
+
+Keyman for Linux makes it possible for you to type in over 2,000 languages on Linux.
+
+[km-config](km-config) <br>
+Keyman keyboards installation and information
+
+[km-kvk2ldml](km-kvk2ldml) <br>
+Convert a Keyman on-screen keyboard file to LDML
+
+[km-package-get](km-package-get) <br>
+Download a Keyman keyboard package
+
+[km-package-install](km-package-install) <br>
+Install a Keyman keyboard package
+
+[km-package-list-installed](km-package-list-installed) <br>
+List installed Keyman keyboard packages
+
+[km-package-uninstall](km-package-uninstall) <br>
+Uninstall a Keyman keyboard package

products/linux/20.0/reference/km-config.md

@@ -0,0 +1,60 @@
+---
+title: km-config
+---
+<!-- DO NOT MODIFY THIS FILE!  It was generated by help2md 1.48.4. -->
+## Summary
+
+Launches Keyman Configuration for installing and showing information about Keyman keyboards
+## Syntax
+
+```bash
+km-config [-h] [-i INSTALL] [--version] [-v] [-vv] [INSTALL]
+```
+
+### Parameters
+
+`INSTALL` <br>
+download and/or install .kmp package. INSTALL can
+either be a downloaded .kmp file, a file:// URL
+pointing to a .kmp file, or a keyman:// URL, possibly
+with a bcp47=`language` specified (e.g. keyman://downl
+oad/keyboard/sil_el_ethiopian_latin?bcp47=ssy-latn).
+
+#### options:
+`-h`, `--help` <br>
+show this help message and exit
+
+`-i INSTALL`, `--install INSTALL` <br>
+download and/or install .kmp package. INSTALL can
+either be a downloaded .kmp file, a file:// URL
+pointing to a .kmp file, or a keyman:// URL, possibly
+with a bcp47=`language` specified (e.g. keyman://downl
+oad/keyboard/sil_el_ethiopian_latin?bcp47=ssy-latn).
+
+`--version` <br>
+show program's version number and exit
+
+`-v`, `--verbose` <br>
+verbose logging
+
+`-vv`, `--veryverbose` <br>
+very verbose logging
+
+## Description
+
+Keyman makes it possible for you to type in over 2,500 languages on Windows, Linux,
+macOS, iPhone, iPad, Android tablets and phones, and even instantly in your web browser.
+
+With the world's most powerful keyboarding engine, intuitive and rapid text input is now
+possible in your language, and for over 99% of the global population's mother tongues!
+
+km-config shows the currently installed Keyman keyboard packages and allows
+you to view information about them. It enables you to download new keyboard
+packages from the website or install from local files.
+## See also
+
+- [`km-package-install`](km-package-install)
+ <br>
+- [`km-package-list-installed`](km-package-list-installed)
+ <br>
+- [`km-package-uninstall`](km-package-uninstall)

products/linux/20.0/reference/km-kvk2ldml.md

@@ -0,0 +1,47 @@
+---
+title: km-kvk2ldml
+---
+<!-- DO NOT MODIFY THIS FILE!  It was generated by help2md 1.48.4. -->
+## Summary
+
+Convert a Keyman on-screen keyboard file to LDML
+## Syntax
+
+```bash
+km-kvk2ldml [-h] [-p] [-k] [-o LDMLFILE] [--version] [-v] [-vv] kvkfile
+```
+
+### Parameters
+
+`kvkfile` <br>
+kvk file
+
+#### options:
+`-h`, `--help` <br>
+show this help message and exit
+
+`-p`, `--print` <br>
+print kvk details
+
+`-k`, `--keys` <br>
+if printing also print all keys
+
+`-o LDMLFILE`, `--output LDMLFILE` <br>
+output LDML file location
+
+`--version` <br>
+show program's version number and exit
+
+`-v`, `--verbose` <br>
+verbose logging
+
+`-vv`, `--veryverbose` <br>
+very verbose logging
+
+## Description
+
+Convert a Keyman kvk on-screen keyboard file to an LDML file. Optionally print
+the details of the kvk file.
+## See also
+
+- [`km-config`](km-config)

products/linux/20.0/reference/km-package-get.md

@@ -0,0 +1,43 @@
+---
+title: km-package-get
+---
+<!-- DO NOT MODIFY THIS FILE!  It was generated by help2md 1.48.4. -->
+## Summary
+
+Download a Keyman keyboard package
+## Syntax
+
+```bash
+km-package-get [-h] [--version] [-v] [-vv] id
+```
+
+### Parameters
+
+`id` <br>
+Keyman keyboard id
+
+#### options:
+`-h`, `--help` <br>
+show this help message and exit
+
+`--version` <br>
+show program's version number and exit
+
+`-v`, `--verbose` <br>
+verbose logging
+
+`-vv`, `--veryverbose` <br>
+very verbose logging
+
+## Description
+
+Download Keyman keyboard package to `~/.cache/keyman`
+## See also
+
+- [`km-package-install`](km-package-install)
+ <br>
+- [`km-config`](km-config)
+ <br>
+- [`km-package-list-installed`](km-package-list-installed)
+ <br>
+- [`km-package-uninstall`](km-package-uninstall)

products/linux/20.0/reference/km-package-install.md

@@ -0,0 +1,66 @@
+---
+title: km-package-install
+---
+<!-- DO NOT MODIFY THIS FILE!  It was generated by help2md 1.48.4. -->
+## Summary
+
+Install a Keyman keyboard package
+## Syntax
+
+```bash
+km-package-install [-h] [-s] [-f KMPFILE] [-p PACKAGE] [-l LANGTAG] [--force] [--version] [-v] [-vv]
+```
+
+## Description
+
+Install a Keyman keyboard package, either a local .kmp file or specify a
+keyboard id to download and install, optionally specifying a language for
+which to install the keyboard.
+#### options:
+.TP
+?-h, --help
+?show this help message and exit
+.TP
+?-s, --shared
+?Install to shared area `/usr/local`
+.TP
+?-f KMPFILE, --file KMPFILE
+?Keyman kmp file
+.TP
+?-p PACKAGE, --package PACKAGE
+?Keyman package id
+.TP
+?-l LANGTAG, --bcp47 LANGTAG
+?bcp47 language tag
+.TP
+?--force
+?force installation of keyboard even if it is a
+downgrade to an older version of the keyboard
+.TP
+?--version
+?show program's version number and exit
+.TP
+?-v, --verbose
+?verbose logging
+.TP
+?-vv, --veryverbose
+?very verbose logging
+
+Example: km-package-install -s -p sil_el_ethiopian_latin --bcp47 ssy-latn
+## Tab completion
+
+
+You may use tab completion to find keyboard packages to install.
+The list comes from the network so there may be a small delay before
+tab completion will work the first time you use it.
+The list of packages is cached for one week.
+
+The list is the full list including keyboards that do not work on
+Linux, so they won't necessarily install.
+## See also
+
+- [`km-config`](km-config)
+ <br>
+- [`km-package-list-installed`](km-package-list-installed)
+ <br>
+- [`km-package-uninstall`](km-package-uninstall)