Skip to content

Commit 0cc9430

Browse files
committed
Expand documentation for the load command
1 parent 5d3a663 commit 0cc9430

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

tmuxp/cli.py

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -451,8 +451,24 @@ def command_freeze(session_name, socket_name, socket_path):
451451
help='Like -2, but indicates that the terminal supports 88 colours.')
452452
def command_load(ctx, config, socket_name, socket_path, answer_yes,
453453
detached, colors):
454-
"""Load a tmux workspace from one or multiple CONFIG path to config file,
455-
directory with config file or session name.
454+
"""Load a tmux workspace from each CONFIG.
455+
456+
CONFIG is a specifier for a configuration file.
457+
458+
If CONFIG is a path to a directory, tmuxp will search it for ".tmuxp.{yaml,yml,json}".
459+
460+
If CONFIG is has no directory component and only a filename, e.g. "myconfig.yaml", tmuxp will
461+
search the users's config directory for that file.
462+
463+
If CONFIG has no directory component, and only a name with no extension, e.g. "myconfig",
464+
tmuxp will search the users's config directory for any file with the extension ".yaml", ".yml",
465+
or ".json" that matches that name.
466+
467+
If multiple configuration files that match a given CONFIG are found, tmuxp will warn and pick
468+
the first one found.
469+
470+
If multiple CONFIGs are provided, workspaces will be created for all of them. The last one
471+
provided will be attached. The others will be created in detached mode.
456472
"""
457473
util.oh_my_zsh_auto_title()
458474

0 commit comments

Comments
 (0)