s6-ipcclient.html (2269B)
1 <html> 2 <head> 3 <meta name="viewport" content="width=device-width, initial-scale=1.0" /> 4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> 5 <meta http-equiv="Content-Language" content="en" /> 6 <title>s6: the s6-ipcclient program</title> 7 <meta name="Description" content="s6: the s6-ipcclient program" /> 8 <meta name="Keywords" content="s6 s6-ipcclient ipcclient ucspi unix client" /> 9 <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> 10 </head> 11 <body> 12 13 <p> 14 <a href="index.html">s6</a><br /> 15 <a href="//skarnet.org/software/">Software</a><br /> 16 <a href="//skarnet.org/">skarnet.org</a> 17 </p> 18 19 <h1> The <tt>s6-ipcclient</tt> program </h1> 20 21 <p> 22 <tt>s6-ipcclient</tt> is an 23 <a href="https://cr.yp.to/proto/ucspi.txt">UCSPI client tool</a> for 24 Unix domain sockets. It connects to a socket, then executes into 25 a program. 26 </p> 27 28 <h2> Interface </h2> 29 30 <pre> 31 s6-ipcclient [ -q | -Q | -v ] [ -p localpath ] [ -l localname ] <em>path</em> <em>prog...</em> 32 </pre> 33 34 <ul> 35 <li> s6-ipcclient connects to a Unix domain socket on <em>path</em>. </li> 36 <li> It executes into <em>prog...</em> with descriptor 6 reading from 37 the socket and descriptor 7 writing to it. </li> 38 </ul> 39 40 <h2> Environment variables </h2> 41 42 <p> 43 <em>prog...</em> is run with 44 the following variables set: 45 </p> 46 47 <ul> 48 <li> PROTO: always set to IPC </li> 49 <li> IPCLOCALPATH: set to the path associated with the local socket, 50 if any. Be aware that it may contain arbitrary characters. </li> 51 </ul> 52 53 <h2> Options </h2> 54 55 <ul> 56 <li> <tt>-q</tt> : be quiet. </li> 57 <li> <tt>-Q</tt> : be normally verbose. This is the default. </li> 58 <li> <tt>-v</tt> : be verbose. </li> 59 <li> <tt>-p <em>localpath</em></tt> : bind the local 60 socket to <em>localpath</em> before connecting to <em>path</em>. </li> 61 <li> <tt>-l <em>localname</em></tt> : use <em>localname</em> 62 as the value of the IPCLOCALPATH environment variable. </li> 63 </ul> 64 65 <h2> Notes </h2> 66 67 <ul> 68 <li> s6-ipcclient is mostly used to connect a client to a 69 <a href="localservice.html">local service</a> without having 70 to implement networking in the client. For instance, the 71 <a href="s6-sudo.html">s6-sudo</a> program does this. </li> 72 </ul> 73 74 </body> 75 </html>