libixp

git clone git://oldgit.suckless.org/libixp/
Log | Files | Refs | LICENSE

ixpc.1 (2047B)

      1 .TH IXPC 1 ixpc-VERSION
      2 .SH NAME
      3 ixpc \- ixp client
      4 .SH SYNOPSIS
      5 .B ixpc
      6 .RB [ \-a
      7 .IR address ]
      8 .I action
      9 .I file
     10 .br
     11 .B ixpc
     12 .B \-v
     13 .SH DESCRIPTION
     14 .SS Overview
     15 .B ixpc
     16 is a client to access a 9P file server from the command line or from shell
     17 scripts. It can be used to configure
     18 .BR wmii (1).
     19 .SS Options
     20 .TP
     21 .BI \-a " address"
     22 Lets you specify the address to which
     23 .B ixpc
     24 will establish a connection. If this option is not supplied, and the
     25 environment variable IXP_ADDRESS is set,
     26 .B ixpc
     27 will use this value as its address. Currently, the address can only be a
     28 unix socket file or a tcp socket. The syntax for
     29 .I address
     30 is taken (along with many other profound ideas) from the Plan 9 operating
     31 system and has the form
     32 .BR unix!/path/to/socket 
     33 for unix socket files, and
     34 .BR tcp!hostname!port
     35 for tcp sockets.
     36 .TP
     37 .B \-v
     38 Prints version information to stdout, then exits.
     39 .TP
     40 The syntax of the actions is as follows:
     41 .TP
     42 .B write
     43 Writes the supplied data from the standard input to
     44 .IR file,
     45 overwriting any previous data.  The data to be written is arbitrary
     46 and only gains meaning (and restrictions) when it is interpreted by
     47 .BR wmiiwm (1).
     48 See
     49 .B EXAMPLES
     50 below.
     51 .TP
     52 .B xwrite
     53 The same as write, but the data is taken from subsequent arguments,
     54 rather than the standard input.
     55 .TP
     56 .B create
     57 Creates file or directory. If the file exists,
     58 nothing is done.
     59 .TP
     60 .B ls
     61 Lists files and directories.
     62 .TP
     63 .B read
     64 Reads file or directory contents.
     65 .TP
     66 .B remove
     67 Removes file or directory tree.
     68 .SH ENVIRONMENT
     69 .TP
     70 IXP_ADDRESS
     71 See above.
     72 .SH EXAMPLES
     73 .TP
     74 .B ixpc ls /
     75 This prints the root directory of the wmii filesystem, if IXP_ADDRESS is set
     76 to the address of wmii. For more information about the contents of this
     77 filesystem, see
     78 .BR wmiiwm (1).
     79 .TP
     80 .B ixpc xwrite /ctl quit
     81 Write 'quit' to the main control file of the wmii filesystem, effectively
     82 leaving wmii.
     83 .TP
     84 .B ixpc write /keys \< keys.txt
     85 Replace the contents of
     86 .I /keys
     87 with the contents of
     88 .I keys.txt
     89 .SH SEE ALSO
     90 .BR wmii (1)
     91 
     92 http://www.cs.bell-labs.com/sys/man/5/INDEX.html