# Libtmux_unix.Client.rename_window

- **Module:** Libtmux_unix
- **Package:** libtmux-unix
- **Language:** OCaml
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-ocaml/blob/205dfda49742592b479247049d186956e4a4cfe9/unix/libtmux_unix.mli#L299
- **Public owner:** Libtmux_unix
- **Page:** https://libtmux.org/en/ocaml/latest/reference/libtmux_unix-client-rename_window/

```
val rename_window :
  ?cancel:Cancellation.t ->
  t -> Libtmux.Window.target -> name:string -> (unit, Libtmux.Error.t) result
```

Set the global window name. Every session link observes the new name on its next capture; existing snapshots retain the old value.

## Examples

Rename a window. This complete program creates a private daemon, checks its result and closes its clients. Use OCaml 5.5.2 on Linux with tmux 3.3a through 3.8. Run it from the source checkout after following the installation guide.

[Source example](https://github.com/libtmux/libtmux-ocaml/blob/205dfda49742592b479247049d186956e4a4cfe9/examples/showcase_rename_window.ml).

```ocaml
open Libtmux
module Client = Libtmux_unix.Client
module Workspace = Libtmux_unix.Workspace
module Config = Libtmux_workspace.Config
module Plan = Libtmux_workspace.Plan
module Execution = Libtmux_workspace.Execution

let get = function
  | Ok value -> value
  | Error error -> failwith (Format.asprintf "%a" Error.pp error)

let rename_window client (initial : Created.t) _spawn =
  let before =
    Snapshot.find_window
      (get (Client.capture client))
      (Window.Target.id initial.window)
    |> Option.get
  in
  get (Client.rename_window client initial.window ~name:"editor-main");
  let after =
    Snapshot.find_window (get (Client.capture client)) (Window.id before)
    |> Option.get
  in
  assert (Window.name before = "editor");
  assert (Window.name after = "editor-main");
  Printf.printf "renamed: %s\n" (Window.name after)

let with_demo binary use =
  let directory = Filename.temp_dir "libtmux-ocaml-showcase-" "" in
  Fun.protect
    ~finally:(fun () ->
      Sys.readdir directory
      |> Array.iter (fun name -> Sys.remove (Filename.concat directory name));
      Unix.rmdir directory)
    (fun () ->
      let socket = Filename.concat directory "server" in
      (* Give this private daemon a lifetime even if startup fails. *)
      let config_file = Filename.concat directory "tmux.conf" in
      Out_channel.with_open_text config_file (fun output ->
          output_string output "set-option -s exit-unattached on\n");
      let wrapper = Filename.concat directory "tmux" in
      Out_channel.with_open_text wrapper (fun output ->
          Printf.fprintf output "#!/bin/sh\nexec %s -f %s \"$@\"\n"
            (Filename.quote binary)
            (Filename.quote config_file));
      Unix.chmod wrapper 0o700;
      let channel = Unix.open_process_args_in binary [| binary; "-V" |] in
      let version =
        Fun.protect
          ~finally:(fun () ->
            if Unix.close_process_in channel <> Unix.WEXITED 0 then
              failwith "tmux version discovery failed")
          (fun () -> String.trim (input_line channel))
      in
      if not (String.starts_with ~prefix:"tmux " version) then
        failwith "invalid tmux version";
      let version = String.sub version 5 (String.length version - 5) in
      let ready = Filename.concat directory "ready.txt" in
      Out_channel.with_open_text ready (fun output ->
          output_string output "showcase ready\n");
      let spawn =
        Spawn.make (Exec { program = "/bin/cat"; args = [ "-u"; ready; "-" ] })
      in
      let config =
        match
          Config.make ~directory ~session:"showcase"
            [ Config.window ~name:"editor" [ Config.pane ~spawn () ] ]
        with
        | Ok value -> value
        | Error error -> failwith (Format.asprintf "%a" Config.pp_error error)
      in
      let plan =
        match
          Plan.make
            ~endpoint:(Endpoint.socket_path socket)
            ~version ~observed:None config
        with
        | Ok value -> value
        | Error error -> failwith (Format.asprintf "%a" Plan.pp_error error)
      in
      let operation = get (Workspace.submit_bootstrap ~binary:wrapper plan) in
      Fun.protect
        ~finally:(fun () -> get (Workspace.close operation))
        (fun () ->
          let receipt = get (Workspace.await operation) in
          if receipt.status <> Execution.Succeeded then
            failwith "workspace setup failed";
          let client = Option.get (Workspace.client operation) in
          let initial = List.hd (Iarray.get receipt.steps 0).created in
          Printf.printf "socket=%s\n%!" socket;
          let pane =
            Snapshot.find_pane
              (get (Client.capture client))
              (Pane.Target.id initial.pane)
            |> Option.get
          in
          ignore
            (get
               (Client.wait_for_text ~timeout:0.5 client pane
                  ~text:"showcase ready"));
          use client initial spawn))

let () =
  let binary = if Array.length Sys.argv = 2 then Sys.argv.(1) else "tmux" in
  with_demo binary rename_window
```

Run the recorded entry point:

```console
$ opam exec -- dune exec examples/showcase_rename_window.exe -- tmux
```

Expected outcome line, after the temporary socket path:

```text
renamed: editor-main
```

## Parameters

- `cancel?` (`Cancellation.t`)
- `arg1` (`t`)
- `arg2` (`Libtmux.Window.target`)
- `name` (`string`)

## tmux command

The tmux commands behind `rename_window`.

- [`rename-window`](/en/tmux/latest/manual/rename-window/)

## tmux C API

The C declarations in tmux that implement these commands.

- [`cmd_rename_window_entry`](/en/tmux/latest/reference/c-variable-cmd_rename_window_entry/) (attribute)
- [`cmd_rename_window_exec`](/en/tmux/latest/reference/c-function-cmd-rename-window-c-cmd_rename_window_exec/) (function)

## In other ports

Rename a window

| Language | Equivalent |
| --- | --- |
| Python | [`libtmux.Window.rename_window`](/en/py/latest/reference/libtmux-window-rename_window/) (method) |
| Ruby | [`LibTmux::Window#rename`](/en/ruby/latest/reference/libtmux-window-rename/) (method) |
| Lua | [`libtmux.Window:rename`](/en/lua/latest/reference/libtmux-window-rename/) (method) |
| Erlang | [`tmux_window:rename/2`](/en/erlang/latest/reference/tmux_window-rename-2/) (function) |
| Haskell | No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing. |
| TypeScript | [`window.Window.rename`](/en/ts/latest/reference/window-window-rename/) (method) |
| Rust | [`window.Window.rename`](/en/rs/latest/reference/window-window-rename/) (method) |
| Go | [`tmux.Window.Rename`](/en/go/latest/reference/tmux-window-rename/) (method) |
| Java | [`io.github.libtmux.Window.rename`](/en/java/latest/reference/io-github-libtmux-window-window-rename/) (method) |
| C# | [`LibTmux.Window.RenameAsync`](/en/csharp/latest/reference/libtmux-window-renameasync/) (method) |
| C++ | [`libtmux::Window::rename`](/en/cxx/latest/reference/libtmux-window-rename/) (method) |
| Swift | [`Server.rename(_:to:)`](/en/swift/latest/reference/server-rename(_-to-)/) (method) |
| Perl | [`LibTmux::Server::rename_window`](/en/perl/latest/reference/libtmux-server-rename_window/) (method). Explicit Server operation. Captured entities remain local observations; use a new snapshot to observe changes. |

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