Core Library0.xAPI Reference

Choose documentation 3

v0.1.1

Current version

v0.1.1
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-ruby v0.1.1

Server.new_session

Behavior: Creation.

Source and package
Qualified name
LibTmux::Async::Server#new_session
Module
LibTmux::Async
Declared in
Server
Package
libtmux-async
Source
gems/libtmux/lib/libtmux/server.rb
def new_session: ( name: ::String, command: ::Array[::String], receipt: true, ?width: ::Integer?, ?height: ::Integer?, ?window_name: ::String?, ?cwd: ::String?, ?environment: ::Hash[::String, ::String], ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::CreationReceiptdef new_session: ( name: ::String, command: ::Array[::String], ?receipt: false, ?width: ::Integer?, ?height: ::Integer?, ?window_name: ::String?, ?cwd: ::String?, ?environment: ::Hash[::String, ::String], ?timeout: ::Numeric, ?cancel: untyped ) -> ::LibTmux::Session

Public owner: LibTmux::Server#new_session

Description#

Behavior contract: Creation.

Parameters
  • name (::String) #

  • command (::Array[::String]) #

  • receipt (true) # for new_session(name, command, receipt, width, height, window_name, cwd, environment, timeout, cancel) [overload 1]

  • width (::Integer?) #

  • height (::Integer?) #

  • window_name (::String?) #

  • cwd (::String?) #

  • environment (::Hash[::String, ::String]) #

  • timeout (::Numeric) #

  • cancel (untyped) #

  • receipt (false) # for new_session(name, command, receipt, width, height, window_name, cwd, environment, timeout, cancel) [overload 2]

tmux command#

The tmux commands behind new_session.

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
Esc

Type to search.

Reference previewOpen reference