repos / zmx

commit

a880a85

parent

a0ead2f

author

Eric Bower

date

2025-11-26 21:39:09 -0500 EST

docs: readme

 1@@ -10,9 +10,9 @@ session persistence for terminal processes
 2 - Native terminal scrollback
 3 - Manage shell sessions
 4 - Multiple clients can connect to the same session
 5-- Each session creates its own unix socket file `/tmp/zmx/`
 6-- Re-attaching to a session restores previous terminal state and output
 7 - The `daemon` and client processes communicate via a unix socket
 8+- Each session creates its own unix socket file `/tmp/zmx/*`
 9+- Re-attaching to a session restores previous terminal state and output
10 - This project does **NOT** provide windows, tabs, or window splits
11 - Works on mac and linux
12 
13@@ -70,15 +70,15 @@ todo.
14 
15 ## socket file location
16 
17-Each session gets its own unix socket file.  Right now, the default location is `/tmp/zmx`.  At the moment this is not configurable.
18+Each session gets its own unix socket file. Right now, the default location is `/tmp/zmx`. At the moment this is not configurable.
19 
20 ## debugging
21 
22-We store global logs for cli commands in `/tmp/zmx/logs/zmx.log`.  We store session-specific logs in `/tmp/zmx/logs/{session_name}.log`.  These logs rotate to `.old` after 5MB.  At the moment this is not configurable.
23+We store global logs for cli commands in `/tmp/zmx/logs/zmx.log`. We store session-specific logs in `/tmp/zmx/logs/{session_name}.log`. These logs rotate to `.old` after 5MB. At the moment this is not configurable.
24 
25 ## a note on configuration
26 
27-At this point, nothing is configurable and we aren't convinced they should ever be configurable.  Configuration adds complexity and it forces maintainers to support users changing the default behavior.  This is a burden.  For example, if we allow changing the detach key shortcut then we need to debug all the different incantations people come up with which can be very tricky in a terminal environment.  We have figured out how to support `ctrl+\` because we think this is a great option.  Tread lightly when submitting PRs to add configuration to this tool.  Having said that, we will always entertain configuration ideas.
28+At this point, nothing is configurable and we aren't convinced they should ever be configurable. Configuration adds complexity and it forces maintainers to support users changing the default behavior. This is a burden. For example, if we allow changing the detach key shortcut then we need to debug all the different incantations people come up with which can be very tricky in a terminal environment. We have figured out how to support `ctrl+\` because we think this is a great option. Tread lightly when submitting PRs to add configuration to this tool. Having said that, we will always entertain configuration ideas.
29 
30 ## a smol contract
31