Core Library0.xAPI Reference

Choose documentation 1

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-raku latest

Server.start

Start an owned foreground daemon on a fresh private socket and create its first session.

Source and package
Qualified name
LibTmux::Server.start
Module
LibTmux
Declared in
Server
Package
LibTmux
Source
lib/LibTmux/Server.rakumod
Other languages
Perl Erlangfunction PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript RustGo Java C# C++ Swift Kotlin Scala OCaml F# Clojure
method start(:$name = 'main', :$binary = 'tmux', :$shell-command = Str, :$width = 80, :$height = 24, :$environment = %*ENV, :$cwd = $*CWD, :$timeout-ms = 10_000, :$max-output-bytes = 8 * 1024 * 1024, :$max-command-bytes = 12 * 1024, :$cancel = Cancellation)

Description#

Start an owned foreground daemon on a fresh private socket and create its first session.

tmux command#

The tmux commands behind start.

tmux C API#

The C declarations in tmux that implement these commands.

Each path starts at a function a command runs, which is degree 1. The degree counts steps from there along the path, and each step is a call or a reference: degree 2 is reached from that function, degree 3 from the next, and so on.

Create a session and its first pane

  1. 1 cmd_new_session_exec
  2. calls → 2 spawn_window
  3. calls → 3 spawn_pane
  4. calls → 4 window_add_pane
  5. calls → 5 window_pane_create

In other ports#

Start the server without creating a session

Equivalents of Start the server without creating a session in other languages
Language Equivalent
Python libtmux.Server.start_server
Erlang tmux_server:start_owned/1 Starts a private daemon and returns an ownership token.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no equivalent on Server
Rust server.Server.start
Go tmux.Server.Start
Java no equivalent on Server
C# LibTmux.Server.StartServerAsync
C++ no equivalent on Server
Swift Server.startServer()
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 Ruby, Lua, PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference