shithub: mq

ref: ca32bdbe21c2092e50d6945950463a76520f499f
dir: /man/1/pin/

View raw version
.TH PIN 1
.SH NAME
pin \- pinned I/O shell
.SH SYNOPSIS
pin
[
.B -acw
] [
.B -m
.I mtpt
] [
.B -s
.I mq
] [
.I id
] [
.I command
]
.SH DESCRIPTION
.PP
.B Pin
manages persistent sessions for long-running commands.
It is used to create, join, and control sessions for programs
connected to a named
.IR mq (4)
stream group.
.PP
The 
.B -c
flag creates a session
.I id
running
.I command,
or
.B rc -i
if command is not given.
.PP
The
.B -a
flag attaches to a session
.I id.
.PP
The -w
flag writes the
.I command
string, or standard input if not given, to
a session's input stream.
.PP
Under the hood,
.I pin
expects an
.IR mq (4)
instance mounted on
.B /n/pin
or
.I mtpt
in case the
.B -m
option is given.
If no such mount is present,
.I pin
mounts the channel posted on
.B /srv/pin-$user
or
.B /srv/$mq
in case the
.B -s
option is given, creating it if needed.
.SH EXAMPLES
.PP
Pin an
.BR rc (1)
shell and attach to it
.EX
	pin -ca myshell
.EE
.PP
Pin another program
.EX
	pin -c remote rcpu -h remote
.EE
.PP
Send input to a pinned program
.EX
	pin -w myshell echo 'hi, shell'
.EE
or
.EX
	echo 'echo hi, shell' | pin -w myshell
.EE
.SH SEE ALSO
.IR mq (4)
.SH SOURCE
.EX
git://src.a-b.xyz/mq
.EE
.SH BUGS