Skip to content

Commit

Permalink
doc: remove refs to start script variants
Browse files Browse the repository at this point in the history
garlick committed Sep 26, 2014

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent e64d422 commit da929a2
Showing 2 changed files with 6 additions and 33 deletions.
35 changes: 5 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -45,48 +45,23 @@ Saving $HOME/.flux/curve/server_private
No administrator privilege is required to start a Flux comms
session as described below.

##### Single rank session
##### Single node session

To start a single-rank (size = 1) Flux comms session:
To start a Flux comms session (size = 8) on the local node:
```
cd src/cmd
./flux start-single
./flux start --size 8
```
A shell is spawned that has its environment set up so that Flux
commands can find the message broker socket. When the shell exits,
the session exits. Log output will be written to stderr.

##### Screen session

To start a Flux comms session (size = 8) using screen:
```
cd src/cmd
./flux start-screen -N8
```
Each broker instance runs in its own screen window.
Rank 0 will spawn a shell. Connect to it by attaching
to window 0 of the screen session:
```
./flux start-screen --attach 0
```
or detach with
```
ctrl-a d
```
Exiting the rank 0 shell will terminate the session, but will
leave screen running. To terminate the screen session and the Flux
session if it is still running:
```
./flux start-screen --shutdown
```
Log output will be written to the file `cmbd.log`.
the session exits. Log output will be written to the file `cmbd.log`.

##### SLURM session

To start a Flux comms session (size = 64) on a cluster using SLURM:
```
cd src/cmd
./flux start-srun -N 64
./flux start -N 64
```
The srun --pty option is used to connect to the rank 0 shell.
When you exit this shell, the session terminates.
4 changes: 1 addition & 3 deletions src/cmd/flux.c
Original file line number Diff line number Diff line change
@@ -70,11 +70,9 @@ static void usage (void)
"\n"
"The flux-core commands are:\n"
" keygen Generate CURVE keypairs for session security\n"
" start Bootstrap a comms session interactively\n"
" kvs Access the Flux the key-value store\n"
" module Load/unload comms modules\n"
" start-single Start a single-rank comms session interactively\n"
" start-screen Start a single-node comms session under screen\n"
" start-srun Start a multi-node comms session under SLURM\n"
" up Show state of all broker ranks\n"
" ping Time round-trip RPC on the comms rank-request network\n"
" mping Time round-trip group RPC to the mecho comms module\n"

0 comments on commit da929a2

Please sign in to comment.