Python API

libtmux.Server.source_file

Python

Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Ruby Lua TypeScript Rust Go Java .NET C++Swift

source_file ( self , path : StrPath , quiet : bool | None = None , parse_only : bool | None = None , verbose : bool | None = None ) → None method [source] ¶ method [source] ¶ source_file

Source a tmux configuration file via $ tmux source-file.

Parameters

path ( StrPath ) – Path to the configuration file.
quiet ( bool | None ) – Suppress errors for missing files (-q flag).
parse_only ( bool | None ) – Check syntax only, do not execute (-n flag).
verbose ( bool | None ) – Show parsed commands (-v flag).

In other ports Load a tmux configuration file

Ruby LibTmux::Server#source_file
Lua No source-verified Lua equivalent is recorded for this operation.
TypeScript server.Server.sourceFile
Rust server.Server.source_file
Go tmux.Server.SourceFile
Java io.github.libtmux.Server.Server.sourceFile
.NET LibTmux.Server.SourceFileAsync
C++ libtmux::Server::source_file
Swift Server.sourceFile(_:)

Examples

Python TypeScript

>>> import pathlib
>>> conf = pathlib.Path(request.config.rootdir) / '..' / 'tmp_src.conf'
>>> _ = conf.write_text('set -g @test_source yes')
>>> server.source_file(str(conf))

await server.sourceFile(`${process.env["HOME"] ?? "."}/.tmux.conf`);

0 declared, 0 inherited