Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

method libtmux-go latest

Server.SourceFile

SourceFile loads or parses one tmux configuration file. The path expands ~ and ~/... for the current user and normalizes redundant separators and dot components without collapsing parent components. Named-user forms are rejected. Exact "-" is rejected because it requires process stdin; a relative path naming a file called "-" remains file data. It can mutate tmux configuration; completed stderr is an error, and cancellation does not prove that parsing or sourcing did not occur.

Source and package
Qualified name
tmux.Server.SourceFile
Package
tmux
Declared in
Server
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/server_exec.go
Other languages
Perl Erlangfunction PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustJavaC#C++Swift Kotlin Scala OCaml F# Clojure

tmux command#

The tmux commands behind SourceFile.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Load a tmux configuration file

Equivalents of Load a tmux configuration file in other languages
Language Equivalent
Python libtmux.Server.source_file
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
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#.

Esc

Type to search.

Reference previewOpen reference