Add new lock-file setting to the config doc and reference config

Change-Id: If3af9429d708bb5d877f31cbc34dec34bd21a544
This commit is contained in:
Doug Wiegley 2016-07-21 17:43:12 -06:00
parent 8c74f9964f
commit 0691f307a1
2 changed files with 8 additions and 0 deletions

View File

@ -107,6 +107,10 @@ line.
Gertty listens on a unix domain socket for remote commands at Gertty listens on a unix domain socket for remote commands at
~/.gertty.sock. This option may be used to change the path. ~/.gertty.sock. This option may be used to change the path.
**lock-file**
Gertty uses a lock file per server to prevent multiple processes
from running at the same time. The default is ~/.gertty.servername.lock
Example: Example:
.. code-block: yaml .. code-block: yaml

View File

@ -13,6 +13,7 @@ servers:
# account settings to generate/retrieve this password. # account settings to generate/retrieve this password.
password: CHANGEME password: CHANGEME
git-root: ~/git/ git-root: ~/git/
lock-file: ~/.gertty.CHANGEME.lock
# Each server section can have the following fields: # Each server section can have the following fields:
# A name that describes the server, to reference on the command line. [required] # A name that describes the server, to reference on the command line. [required]
@ -53,6 +54,9 @@ servers:
# Gertty listens on a unix domain socket for remote commands at # Gertty listens on a unix domain socket for remote commands at
# ~/.gertty.sock. You may change the path here: # ~/.gertty.sock. You may change the path here:
# socket: ~/.gertty.sock # socket: ~/.gertty.sock
# Gertty uses a lock file per server to prevent multiple processes
# from running at the same time. Example:
# lock-file: /run/lockme.lock
# Gertty comes with two palettes defined internally. The default # Gertty comes with two palettes defined internally. The default
# palette is suitable for use on a terminal with a dark background. # palette is suitable for use on a terminal with a dark background.