Server.source_file
Run the commands in a file, the way tmux runs a configuration file.
Source and package
- Qualified name
-
libtmux::Server:: source _file - Namespace
- libtmux
- Declared in
Server- Package
- libtmux-cxx
- Source
- include/libtmux/server.hpp
- Other languages
- Perl Erlangfunction PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptRustGoJavaC#Swift Kotlin Scala OCaml F# Clojure
- [[
C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.]] expected<void, CommandFailure > source_file(const std::filesystem:: & file) const;path -
Description#
The server reads the file, so the path is the server's to resolve. A file it cannot read is reported rather than passed over. A control-backed Server rejects execution because the file can add an unknowable number of reply blocks;
check_file()remains available there.- Parameters
-
-
file(const std::filesystem:: &) #path
-
tmux command#
The tmux commands behind source_file.
tmux C API#
The C declarations in tmux that implement these commands.
In other ports#
Load a tmux configuration file
| Language | Equivalent |
|---|---|
| Python | libtmux |
| Ruby | Lib |
| Erlang | tmux 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 |
| Rust | server |
| Go | tmux |
| Java | io |
| C# | Lib |
| Swift | Server |
| 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#.