footclient(1)

1footclient(1)               General Commands Manual              footclient(1)
2
3
4

NAME

6       footclient - start new terminals in a foot server
7

SYNOPSIS

9       footclient [OPTIONS]
10       footclient [OPTIONS] <command> [COMMAND OPTIONS]
11
12       All trailing (non-option) arguments are treated as a command, and its
13       arguments, to execute (instead of the default shell).
14

DESCRIPTION

16       footclient is used together with foot(1) in --server mode.
17
18       Running it without arguments will open a new terminal window (hosted in
19       the foot server), with your default shell. The exit code will be that
20       of the terminal. I.e footclient does not exit until the terminal has
21       terminated.
22

OPTIONS

24       -t,--term=TERM
25           Value to set the environment variable TERM to (see TERMINFO and EN‐
26           VIRONMENT). Default: foot.
27
28       -T,--title=TITLE
29           Initial window title. Default: foot.
30
31       -a,--app-id=ID
32           Value to set the app-id property on the Wayland window to. Default:
33           foot.
34
35       -w,--window-size-pixels=WIDTHxHEIGHT
36           Set initial window width and height, in pixels. Default: 700x500.
37
38       -W,--window-size-chars=WIDTHxHEIGHT
39           Set initial window width and height, in characters. Default: not
40           set.
41
42       -m,--maximized
43           Start in maximized mode. If both --maximized and --fullscreen are
44           specified, the last one takes precedence.
45
46       -F,--fullscreen
47           Start in fullscreen mode. If both --maximized and --fullscreen are
48           specified, the last one takes precedence.
49
50       -L,--login-shell
51           Start a login shell, by prepending a '-' to argv[0].
52
53       -D,--working-directory=DIR
54           Initial working directory for the client application. Default: CWD
55           of footclient.
56
57       -s,--server-socket=PATH
58           Connect to PATH instead of $XDG_RUNTIME_DIR/foot-$WAYLAND_DIS‐
59           PLAY.sock.
60
61       -H,--hold
62           Remain open after child process exits.
63
64       -N,--no-wait
65           Detach the client process from the running terminal, exiting imme‐
66           diately.
67
68       -o,--override=[SECTION.]KEY=VALUE
69           Override an option set in the configuration file. If SECTION is not
70           given, defaults to main.
71
72       -d,--log-level={info,warning,error,none}
73           Log level, used both for log output on stderr as well as syslog.
74           Default: info.
75
76       -l,--log-colorize=[{never,always,auto}]
77           Enables or disables colorization of log output on stderr.
78
79       -v,--version
80           Show the version number and quit
81
82       -e
83           Ignored; for compatibility with xterm -e. See foot(1) for more de‐
84           tails.
85

EXIT STATUS

87       Footlient will exit with code 220 if there is a failure in footclient
88       itself (for example, the server socket does not exist).
89
90       If -N,--no-wait is used, footclient exits with code 0 as soon as the
91       foot server has been instructed to open a new window.
92
93       If not, footclient may also exit with code 230. This indicates a fail‐
94       ure in the foot server.
95
96       In all other cases the exit code is that of the client application
97       (i.e. the shell).
98

TERMINFO

100       Client applications use the terminfo identifier specified by the envi‐
101       ronment variable TERM (set by foot) to determine terminal capabilities.
102
103       Foot has two terminfo definitions: foot and foot-direct, with foot be‐
104       ing the default.
105
106       The difference between the two is in the number of colors they de‐
107       scribe; foot describes 256 colors and foot-direct 16.7 million colors
108       (24-bit truecolor).
109
110       Note that using the foot terminfo does not limit the number of usable
111       colors to 256; applications can still use 24-bit RGB colors. In fact,
112       most applications work best with foot (including 24-bit colors)). Using
113       *-direct terminfo entries has been known to crash some ncurses applica‐
114       tions even.
115
116       There are however applications that need a *-direct terminfo entry for
117       24-bit support. Emacs is one such example.
118
119       While using either foot or foot-direct is strongly recommended, it is
120       possible to use e.g. xterm-256color as well. This can be useful when
121       remoting to a system where foot's terminfo entries cannot easily be in‐
122       stalled.
123
124       Note that terminfo entries can be installed in the user's home direc‐
125       tory. I.e. if you do not have root access, or if there is no distro
126       package for foot's terminfo entries, you can install foot's terminfo
127       entries manually, by copying foot and foot-direct to ~/.terminfo/f/.
128

ENVIRONMENT

130       The following environment variables are used by footclient:
131
132       XDG_RUNTIME_DIR
133           Used to construct the default PATH for the --server-socket option,
134           when no explicit argument is given (see above).
135
136       WAYLAND_DISPLAY
137           Used to construct the default PATH for the --server-socket option,
138           when no explicit argument is given (see above).
139
140       The following environment variables are set in the child process:
141
142       TERM
143           terminfo/termcap identifier. This is used by client applications to
144           determine which capabilities a terminal supports. The value is set
145           according to either the --term command-line option or the term con‐
146           fig option in foot.ini(5).
147
148       COLORTERM
149           This variable is set to truecolor, to indicate to client applica‐
150           tions that 24-bit RGB colors are supported.
151