Codebergdnkl

foot

master
ply5 git calls29 ms31 KiB3 cachedprotocol v2
217 lines6.8 KiBRaw
1footclient(1)
3# NAME
4footclient - start new terminals in a foot server
6# SYNOPSIS
7*footclient* [_OPTIONS_]++
8*footclient* [_OPTIONS_] <_command_> [_COMMAND OPTIONS_]
10All trailing (non-option) arguments are treated as a command, and its
11arguments, to execute (instead of the default shell).
13# DESCRIPTION
15*footclient* is used together with *foot*(1) in *--server*
16mode.
18Running it without arguments will open a new terminal window (hosted
19in the foot server), with your default shell. The exit code will be
20that of the terminal. I.e *footclient* does not exit until the
21terminal has terminated.
23# OPTIONS
25*-t*,*--term*=_TERM_
26 Value to set the environment variable *TERM* to (see *TERMINFO*
27 and *ENVIRONMENT*). Default: _@default_terminfo@_.
29*-T*,*--title*=_TITLE_
30 Initial window title. Default: _foot_.
32*-a*,*--app-id*=_ID_
33 Value to set the *app-id* property on the Wayland window
34 to. Default: _foot_ (normal mode), or _footclient_ (server mode).
36*--class*=_ID_
37 Alias for *--app-id*.
39*toplevel-tag*=_TAG_
40 Value to set the *toplevel-tag* property on the Wayland window
41 to. The compositor can use this value for session management,
42 window rules etc. Default: _not set_
44*-w*,*--window-size-pixels*=_WIDTHxHEIGHT_
45 Set initial window width and height, in pixels. Default: _700x500_.
47*-W*,*--window-size-chars*=_WIDTHxHEIGHT_
48 Set initial window width and height, in characters. Default: _not set_.
50*-m*,*--maximized*
51 Start in maximized mode. If both *--maximized* and *--fullscreen*
52 are specified, the _last_ one takes precedence.
54*-F*,*--fullscreen*
55 Start in fullscreen mode. If both *--maximized* and *--fullscreen*
56 are specified, the _last_ one takes precedence.
58*-L*,*--login-shell*
59 Start a login shell, by prepending a '-' to argv[0].
61*-D*,*--working-directory*=_DIR_
62 Initial working directory for the client application. Default:
63 _CWD of footclient_.
65*-s*,*--server-socket*=_PATH_
66 Connect to _PATH_ instead of
67 *$XDG\_RUNTIME\_DIR/foot-$WAYLAND\_DISPLAY.sock*.
69*-H*,*--hold*
70 Remain open after child process exits.
72*-N*,*--no-wait*
73 Detach the client process from the running terminal, exiting
74 immediately.
76*-o*,*--override*=[_SECTION_.]_KEY_=_VALUE_
77 Override an option set in the configuration file. If _SECTION_ is not
78 given, defaults to _main_.
80*-E*,*--client-environment*
81 The child process in the new terminal instance will use
82 footclient's environment, instead of the server's.
84 Environment variables listed in the *Variables set in the child
85 process* section will be overwritten by the foot server. For
86 example, the new terminal will use *TERM* from the configuration,
87 not footclient's environment.
89*-d*,*--log-level*={*info*,*warning*,*error*,*none*}
90 Log level, used both for log output on stderr as well as
91 syslog. Default: _warning_.
93*-l*,*--log-colorize*=[{*never*,*always*,*auto*}]
94 Enables or disables colorization of log output on stderr.
96*-v*,*--version*
97 Show the version number and quit
99*-e*
100 Ignored; for compatibility with *xterm -e*. See *foot*(1) for more
101 details.
103# EXIT STATUS
105Footclient will exit with code 220 if there is a failure in footclient
106itself (for example, the server socket does not exist).
108If *-N*,*--no-wait* is used, footclient exits with code 0 as soon as
109the foot server has been instructed to open a new window.
111If not, footclient may also exit with code 230. This indicates a
112failure in the foot server.
114In all other cases the exit code is that of the client application
115(i.e. the shell).
117# TERMINFO
119Client applications use the terminfo identifier specified by the
120environment variable *TERM* (set by foot) to determine terminal
121capabilities.
123Foot has two terminfo definitions: *foot* and *foot-direct*, with
124*foot* being the default.
126The difference between the two is in the number of colors they
127describe; *foot* describes 256 colors and *foot-direct* 16.7 million
128colors (24-bit truecolor).
130Note that using the *foot* terminfo does not limit the number of
131usable colors to 256; applications can still use 24-bit RGB colors. In
132fact, most applications work best with *foot* (including 24-bit
133colors)). Using *\*-direct* terminfo entries has been known to crash
134some ncurses applications even.
136There are however applications that need a *\*-direct* terminfo entry
137for 24-bit support. Emacs is one such example.
139While using either *foot* or *foot-direct* is strongly recommended, it
140is possible to use e.g. *xterm-256color* as well. This can be useful
141when remoting to a system where foot's terminfo entries cannot easily
142be installed.
144Note that terminfo entries can be installed in the user's home
145directory. I.e. if you do not have root access, or if there is no
146distro package for foot's terminfo entries, you can install foot's
147terminfo entries manually, by copying *foot* and *foot-direct* to
148*~/.terminfo/f/*.
150# ENVIRONMENT
152## Variables used by footclient
154*XDG\_RUNTIME\_DIR*
155 Used to construct the default _PATH_ for the *--server-socket*
156 option, when no explicit argument is given (see above).
158*WAYLAND\_DISPLAY*
159 Used to construct the default _PATH_ for the *--server-socket*
160 option, when no explicit argument is given (see above).
162If the socket at default _PATH_ does not exist, *footclient* will
163fallback to the less specific path, with the following priority:
164*$XDG\_RUNTIME\_DIR/foot-$WAYLAND\_DISPLAY.sock*,
165*$XDG\_RUNTIME\_DIR/foot.sock*, */tmp/foot.sock*.
167## Variables set in the child process
169*TERM*
170 terminfo/termcap identifier. This is used by client applications
171 to determine which capabilities a terminal supports. The value is
172 set according to either the *--term* command-line option or the
173 *term* config option in *foot.ini*(5).
175*COLORTERM*
176 This variable is set to *truecolor*, to indicate to client
177 applications that 24-bit RGB colors are supported.
179*PWD*
180 Current working directory (at the time of launching foot)
182*SHELL*
183 Set to the launched shell, if the shell is valid (it is listed in
184 */etc/shells*).
186In addition to the variables listed above, custom environment
187variables may be defined in *foot.ini*(5).
189## Variables *unset* in the child process
191*TERM_PROGRAM*
192*TERM_PROGRAM_VERSION*
193 These environment variables are set by certain other terminal
194 emulators. We unset them, to prevent applications from
195 misdetecting foot.
197In addition to the variables listed above, custom environment
198variables to unset may be defined in *foot.ini*(5).
200# Signals
202The following signals have special meaning in footclient:
204- SIGUSR1: switch to the dark color theme (*[colors-dark]*).
205- SIGUSR2: switch to the light color theme (*[colors-light]*).
207When sending SIGUSR1/SIGUSR2 to a footclient instance, the theme is
208changed in that instance only. This is different from when you send
209SIGUSR1/SIGUSR2 to the server process, where all instances change the
210theme.
212Note: for obvious reasons, this is not supported when footclient is
213started with *--no-wait*.
215# SEE ALSO
217*foot*(1)
Diagnostics5 git calls · 29 ms
CallStatusSizeTime029 ms
discover200178 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=178
git.server.agent=git/2.56.1-Linux
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch server-option object-format
git.server.fetch=shallow wait-for-done filter
git.protocol.version=2
git.pkt.frames=9
git.pkt.data=7
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=178
git.pkt.payload.max=35
ls-refs20010 KiB3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=10322
git.response.cache=UPDATING
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=108
git.pkt.data=107
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=10322
git.pkt.payload.max=106
git.ls_refs.count=107
git.ls_refs.head=refs/heads/master
fetchtree:0 · deepen 102009.3 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=9489
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=tree:0
git.fetch.wants=c0d2c3e95d74cb60526ff28aec9f34ee3df545e0
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=9489
git.pkt.payload.max=9389
git.sideband.band1.bytes=9389
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=10
git.pack.bytes=9389
git.pack.ofs_delta=0
git.pack.ref_delta=0
git.pack.chain.max=0
git.pack.trailer=de930681b6073ba5b599a0f956bfbd114762ad5a
git.pack.full=10
Open pack map
fetchcombine:blob:none+tree:2 · deepen 12008.6 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=23
git.response.bytes=8830
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=combine:blob:none+tree:2
git.fetch.wants=c0d2c3e95d74cb60526ff28aec9f34ee3df545e0
git.fetch.haves.count=0
git.fetch.deepen=1
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=7
git.pkt.data=5
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=8830
git.pkt.payload.max=8730
git.sideband.band1.bytes=8730
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=14
git.pack.bytes=8730
git.fetch.wide.objects=14
git.fetch.wide.extra_bytes=9909
git.fetch.wide.blobs=0
fetch2002.8 KiB · hit23 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=2902
git.response.cache=HIT
git.response.duration_ms=23
git.fetch.wants=92d84c343d5da5b39c0ba75bee259628cd1291db
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=4
git.pkt.data=3
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=2902
git.pkt.payload.max=2875
git.sideband.band1.bytes=2875
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://codeberg.org/dnkl/foot
Ref
refs/heads/master
Commit
c0d2c3e95d74cb60526ff28aec9f34ee3df545e0
cf-ray
a5e2f4a0ebf17089
Request
c8522f06…
Protocol
v2 · sha1
Agent
git/2.56.1-Linux
Filter
advertised
Fetch
shallow wait-for-done filter
Capabilities
agent ls-refs fetch server-option object-format