upterm-session-stop(1)

Usage

upterm {session stop NAME | ID [flags]}

Overview

Stop a running session, given its name or session ID.

NAME|ID is the session's name (the one 'upterm host' printed, or --name gave it) or its session ID; 'upterm session list' shows both.

The session's command is hung up, then terminated, then killed if it stays, and every attached terminal is released. The session's record keeps its outcome: 'upterm session info NAME' reports it as stopped.

A session that has already ended is reported as such and is not an error.

Exits 4 when no session has the name, and 1 for any other failure.

Options

-h, --help[=false]
help for stop

Options inherited from parent commands

--debug[=false]
Enable debug logging (log file: /build/.upterm/upterm.log). A non-empty DEBUG turns it on too.

Examples

  # Stop the session named build-shell:
  upterm session stop build-shell
  # Stop a session given its session ID:
  upterm session stop d3k5fia7m4us73ehblug

Referred to by