File: phosh-session.rst

package info (click to toggle)
phosh 0.53.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 9,868 kB
  • sloc: ansic: 83,377; xml: 3,981; python: 717; sh: 449; makefile: 34; lisp: 22; javascript: 6
file content (56 lines) | stat: -rw-r--r-- 1,460 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
.. _phosh-session(1):

=============
phosh-session
=============

--------------------------------
Session startup script for phosh
--------------------------------

SYNOPSIS
--------
|   **phosh-session** [OPTIONS...]


DESCRIPTION
-----------

``phosh-session`` is the script to startup phosh including required
components like the Wayland compositor ``phoc`` and an on screen
keyboard like ``stevia`` or ``squeekboard``. The script is rarely invoked by a
user but rather activated by a display manager or systemd unit. However it's
perfectly valid to e.g. log into a tty and run ``phosh-session`` to bring up
phosh and needed components.

OPTIONS
-------

``-h``, ``--help``
   Print help and exit

``--version``
   Print version and exit

CONFIGURATION FILES
-------------------
The session script looks at the following configuration files:

- ``/usr/share/phosh/phoc.ini``: Configuration passed to the compositor
- ``/etc/phosh/phoc.ini``: Used instead of the above if present

ENVIRONMENT VARIABLES
---------------------

``phosh-session`` honors the following environment variables:

- ``WLR_BACKENDS``: The backends the wlroots library should use when phoc launches. See
  https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/docs/env_vars.md

For debugging purposes you can put environment variables into
``~/.phoshdebug`` which is read at session startup.

See also
--------

``phosh(1)`` ``phoc(1)`` ``phoc.ini(5)`` ``phosh-osk-stevia(1)``