Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-erlang latest

tmux_command:literal_format/2

Quote a complete literal format argument. Mode tmux protects hash expansion; mode time also protects strftime percent directives. Stored-name semantics remain tmux's own. This handles one expansion pass, not a nested operand, recursive expansion or later visual style rendering. Performs no I/O.

Source and package
Qualified name
tmux_command:literal_format/2
Declared in
tmux_command
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_command.erl
literal_format/2 -spec literal_format(binary(), tmux | time) -> {ok, binary()} | {error, map()}.

Description#

Hash runs before [ stay unchanged because tmux preserves style-looking prefixes for a separate drawing step. Other hashes are doubled. In time mode, an argument containing percent bytes must fit tmux's 8191-byte strftime result limit after hash encoding and before percent doubling; larger values return format_limit with time_bytes and max_bytes. Arguments without percent bytes skip that native time-expansion limit. The encoded 32 KiB command limit still applies in either mode.

Parameters

Guides#

Pages that discuss literal_format/2.

Esc

Type to search.

Reference previewOpen reference