Python API

method libtmux latest

Server.source_file

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

Source and package

Qualified name: libtmux.Server.source_file
Module: libtmux
Declared in: Server
Package: libtmux
Source: src/libtmux/server.py
Other languages: Perl Erlangfunction PowerShell Julia Elixir Haskell Common Lisp Ruby Lua TypeScriptRustGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure

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

Examples#

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

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).

tmux command#

The tmux commands behind source_file.

source-file

tmux C API#

The C declarations in tmux that implement these commands.

cmd_source_file_entry cmd_source_file_exec

In other ports#

Load a tmux configuration file

Equivalents of Load a tmux configuration file in other languages
Language	Equivalent
Ruby	`LibTmux::Server#source_file`
Erlang	`tmux_command:source_file/2` Builds a trusted command value. Execute it explicitly with `tmux_server:command/3`.
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`server.Server.sourceFile`
Rust	`server.Server.source_file`
Go	`tmux.Server.SourceFile`
Java	`io.github.libtmux.Server.sourceFile`
C#	`LibTmux.Server.SourceFileAsync`
C++	`libtmux::Server::source_file`
Swift	`Server.sourceFile(_:)`
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Lua, PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.source_file

Examples#

tmux command#

tmux C API#

In other ports#

Examples#

tmux command#

tmux C API#

In other ports#

Related types#