.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.3 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "phoc" "" "" ""
.SH Name
phoc \- A Wayland compositor for mobile devices
.SH SYNOPSIS
.nf
\fBphoc\fP [OPTIONS...]
.fi
.sp
.SH DESCRIPTION
.sp
\fBphoc\fP is a Wayland compositor for mobile devices using the
\fBwlroots\fP library. It\(aqs often used with the \fBphosh\fP mobile shell
but works perfectly fine on its own.
.SH OPTIONS
.INDENT 0.0
.TP
.B \fB\-h\fP, \fB\-\-help\fP
Print help and exit
.TP
.B \fB\-C\fP, \fB\-\-config FILE\fP
Path to the configuration file. (default: phoc.ini).
.TP
.B \fB\-E\fP, \fB\-\-exec EXECUTABLE\fP
Executable (session) that will be run at startup
.TP
.B \fB\-\-socket\fP
Wayland socket to listen on for client connections
.TP
.B \fB\-S\fP, \fB\-\-shell\fP
Whether to expect a shell to attach
.TP
.B \fB\-X\fP, \fB\-\-xwayland\fP
Whether to start XWayland
.TP
.B \fB\-\-no\-xwayland\fP
Whether to disable XWayland
.TP
.B \fB\-\-version\fP
Show version information
.UNINDENT
.SH CONFIGURATION
.sp
Configuration is read from \fBphoc.ini\fP, \fBhwdb\fP, \fBgsettings\fP and
\fB$XDG_STATE_HOME/outputs.gvdb\fP\&.
For details on output configuration see \fBphoc.ini(5)\fP, for details
on wakeup key configuration via \fBhwdb\fP see \fBgmobile.udev(5)\fP, for details
on the gsettings handled by phoc see \fBphoc.gsettings(5)\fP\&. For details on
output states see \fBphoc\-outputs\-states\fP\&.
.SH ENVIRONMENT VARIABLES
.sp
\fBphoc\fP honors the following environment variables:
.INDENT 0.0
.IP \(bu 2
\fBWLR_BACKENDS\fP: The backends the wlroots library should use when phoc launches. See
\%<https://\:gitlab\:.freedesktop\:.org/\:wlroots/\:wlroots/\:-/\:blob/\:master/\:docs/\:env_vars\:.md>
.IP \(bu 2
\fBWLR_RENDERER\fP: The renderer the wlroots library should use when phoc launches. See
\%<https://\:gitlab\:.freedesktop\:.org/\:wlroots/\:wlroots/\:-/\:blob/\:master/\:docs/\:env_vars\:.md>
.IP \(bu 2
\fBG_MESSAGES_DEBUG\fP, \fBG_DEBUG\fP and other environment variables supported
by glib. \%<https://\:docs\:.gtk\:.org/\:glib/\:running\:.html>
.IP \(bu 2
\fBPHOC_DEBUG\fP: Comma separated list of debugging flags:
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
\fBhelp\fP: Show a list of available debug flags
.IP \(bu 2
\fBauto\-maximize\fP: Maximize toplevels
.IP \(bu 2
\fBdamage\-tracking\fP: Debug damage tracking
.IP \(bu 2
\fBdamage\-whole\fP: Damage whole output on each frame
.IP \(bu 2
\fBno\-quit\fP: Don\(aqt quit when session ends
.IP \(bu 2
\fBtouch\-points\fP: Debug touch points
.IP \(bu 2
\fBlayer\-shell\fP: Debug layer shell
.IP \(bu 2
\fBcutouts\fP: Debug display cutouts and notches
.IP \(bu 2
\fBdisable\-animations\fP: Disable animations
.IP \(bu 2
\fBforce\-shell\-reveal\fP: Always reveal shell over fullscreen apps
.IP \(bu 2
\fBignore\-state\fP: Ignore any saved output state
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH UDEV PROPERTIES
.sp
Apart from the udev properties for wakeup keys documented in \fBgmobile.udev(5)\fP phoc uses
\fBID_INPUT_KEYBOARD\fP to identify hardware keyboards. You can use \fBhwdb\fP to override these.
.SH DBUS INTERFACE
.sp
\fBphoc\fP allows to enable and disable certain debug flags at runtime via DBus. To see a list of
available flags use:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
busctl \-\-user introspect mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl
.EE
.UNINDENT
.UNINDENT
.sp
To toggle individual values:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
busctl \-\-user set\-property mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl TouchPoints b true
busctl \-\-user set\-property mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl DamageTracking b true
busctl \-\-user set\-property mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl LogDomains as 1 all
busctl \-\-user set\-property mobi.phosh.Phoc.DebugControl /mobi/phosh/Phoc/DebugControl mobi.phosh.Phoc.DebugControl LogDomains as 2 phoc\-seat phoc\-layer\-surface
.EE
.UNINDENT
.UNINDENT
.sp
Note that the flags are not considered stable API so can change
between releases.
.SH See also
.sp
\fBphoc.ini(5)\fP \fBphoc.gsettings(5)\fP \fBphoc\-outputs\-states(1)\fP \fBgmobile.udev(5)\fP \fBphosh(1)\fP \fBbusctl\fP
.\" End of generated man page.