abducate

abduco wrapper to mimic rc-style user services
git clone git://git.girlpoison.org/abducate
Log | Files | Refs | README | LICENSE

README (2003B)

      1 Intro
      2 ------
      3 abducate is a small wrapper for abduco designed to run commands in the style of background services.
      4 When starting a service through abducate, the given command is run in a new abduco session. abducate will not attach to it. It will exit
      5 with an error if the given session is already running. Sessions are maintained in a separate directory, $HOME/.abducate by default. 
      6 
      7 Contrived example
      8 ------------------
      9 $ abducate start picom
     10 $ abducate start sxhkd
     11 $ abducate start sxhkd
     12 abducate: already running
     13 $ abducate toggle sxhkd
     14 $ abducate list
     15 Active sessions (on host girlpoison)
     16   Tue	 2024-05-28 13:58:58	9500	picom
     17 
     18 Usage
     19 ------
     20 abducate [-n] [-l label] [start | stop | toggle | list | attach | status] command [args...]
     21 
     22 OPTIONS
     23     -l label
     24         Specify which session to interact with. If omitted, abducate will assume the name
     25         of the given command as the label. To aid in readability, this applies for actions
     26         that don't require a command argument, too.
     27     -n
     28         Trigger a desktop notification after creating or terminating a session.
     29 
     30 ACTIONS
     31     start
     32         Create a new abduco session, if one with the given label is not already running.
     33     stop
     34         Terminate the session with the given label, if it is running.
     35     toggle
     36         Create a new session if it is not currently running. Otherwise, terminate the
     37         session with the given label.
     38     list
     39         Display the list of currently running sessions.
     40     attach
     41         Attach to the specified session.
     42     status
     43         Print the status of the specified session.
     44 
     45 ENVIRONMENT VARIABLES
     46     ABDUCATE_DIR
     47         Specifies the directory in which abducate stores session information. It defaults
     48         to $HOME/.abducate
     49 
     50 Notes
     51 ------
     52 abducate depends on the most recent version of abduco, which displays the PID of the running process in the session listing. Notably, the abduco package from the official Arch Linux repositories is an earlier version. Install abduco-git from the AUR.