diff --git a/fairmq/shmem/README.md b/fairmq/shmem/README.md index 53260557..7dc4f274 100644 --- a/fairmq/shmem/README.md +++ b/fairmq/shmem/README.md @@ -15,7 +15,7 @@ FairMQ Shared Memory currently uses the following names to register shared memor | `fmq__m_` | managed segment(s) (user data) | one of the devices | devices | | `fmq__mng` | management segment (management data) | one of the devices | devices | | `fmq__mtx` | mutex | one of the devices | devices | -| `fmq__cv` | condition variable | one of the devices | devices with unmanaged regions | +| `fmq__cv` | condition variable | one of the devices | devices | | `fmq__rg_` | unmanaged region(s) | one of the devices | devices with unmanaged regions | | `fmq__rgq_` | unmanaged region queue(s) | one of the devices | devices with unmanaged regions | | `fmq__ms` | shmmonitor status | shmmonitor | devices, shmmonitor | @@ -35,7 +35,7 @@ The monitor runs in one of the following modes: | --------------------------- | ---------------------------------------------- | | no args | Print segment info of the specified session/shm ID and exit. | | `--view`,`-v` | Print segment info of the specified session/shm ID and exit. | -| `--interactive`,`-i` | Print segment info of the specified session/shm ID and exit at a given interval (`--interval`), with some keyboard controls. Can be combined with `--view` for read-only access (and avoid receiving heartbeats). | +| `--interactive`,`-i` | Print segment info of the specified session/shm ID at a given interval (`--interval`), with some keyboard controls. Can be combined with `--view` for read-only access (and avoid receiving heartbeats). | | `--monitor`,`-m` | Monitor the session shm usage by receiving heartbeats from shmem users, cleaning it up if no heartbeats arrived within configured timeout (`--timeout`/`-t`). Only one heartbeat receiver per session is currently possible. If `--self-destruct`/`-x` is added, monitor will exit either when (a) no shm has been observed for interval * 2, (b) a cleanup due to reached timeout has been performed, or (c) shm has been observed, but is now cleaned up. | | `--cleanup`,`-c` | Cleanup the shm for the specified session and exit. | | `--debug`,`-b` | Print the list of messages in the current session and exit. Only availabe when FairMQ is compiled with `FAIRMQ_DEBUG_MODE=ON` (high performance impact). | @@ -50,7 +50,6 @@ Additional cmd options: | `--daemonize`,`-d` | Can be combined with the monitoring mode to detach the process from the parent. | | `--verbose`,`-d` | When running as a daemon, store monitor output in `fairmq-shmmonitor_.log` | - -Possible further implementation would be to run the monitor with `--self-destruct` with each topology. +For full option details, run with `-h`. The Monitor class can also be used independently from the supplied executable, allowing integration on any level.