wmii

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

wmiir.1 (3378B)


      1 .TH "wmiir" 1 "Oct, 2009" "wmii-@VERSION@"
      2 
      3 .SH NAME
      4 .P
      5 wmiir \- The wmii 9P filesystem client
      6 
      7 .SH SYNOPSIS
      8 .P
      9 wmiir \fI[\-a \fI<address>\fR]\fR \fI[\-b]\fR {create | ls \fI[\-dlp]\fR | read | remove | write} \fI<file>\fR 
     10 .P
     11 wmiir \fI[\-a \fI<address>\fR]\fR \fI[\-b]\fR xwrite \fI<file>\fR \fI<data>\fR ... 
     12 .P
     13 wmiir \-v
     14 
     15 .SH DESCRIPTION
     16 .P
     17 \fBwmiir\fR is a simple 9P filesystem client which ships with \fBwmii\fR, and connects
     18 to its virtual filesystem by default. \fBwmiir\fR is most often used to query and
     19 issue commands to \fBwmii\fR, both from the command line and from its \fBsh\fR\-based
     20 configuration scripts.
     21 
     22 .P
     23 Since the default encoding of 9P filesystems is UTF\-8, \fBwmiir\fR
     24 assumes that all data read and written is text data and
     25 translates to or from your locale character encoding as
     26 necessary. When working with non\-text data in a non\-UTF\-8
     27 locale, the \fI\-b\fR flag should be specified to disable this
     28 behavior.
     29 
     30 .SH ARGUMENTS
     31 .TP
     32 \-a
     33 The address at which to connect to \fBwmii\fR.
     34 .TP
     35 \-b
     36 
     37 .RS
     38 With the \fI\-b\fR flag, data that you intend to read or
     39 write is treated as binary data.
     40 .RE
     41 .P
     42 :
     43 
     44 .SH COMMANDS
     45 .P
     46 The following commands deal with 9P filesystems.
     47 
     48 .TP
     49 create \fI<file>\fR
     50 Creates a new file or directory in the filesystem. Permissions and
     51 file type are inferred by \fBwmii\fR. The contents of the standard input
     52 are written to the new file.
     53 .TP
     54 ls \fI[\-dlp]\fR \fI<path>\fR
     55 Lists the contents of \fI<path>\fR.
     56 
     57 Flags:
     58 .RS 8
     59 .TP
     60 \-d
     61 Don't list the contents of directories.
     62 .TP
     63 \-l
     64 Long output. For each file, list its permissions, owner,
     65 group, size (bytes), mtime, and name.
     66 .TP
     67 \-p
     68 Print the full path to each file.
     69 .RS -8
     70 .TP
     71 read \fI<file>\fR
     72 Reads the entire contents of a file from the filesystem. Blocks until
     73 interrupted or EOF is received.
     74 
     75 Synonyms: \fBcat\fR
     76 .TP
     77 remove \fI<path>\fR
     78 Removes \fI<path>\fR from the filesystem.
     79 
     80 Synonyms: \fBrm\fR
     81 .TP
     82 write \fI<file>\fR
     83 Writes the contents of the standard input to \fI<file>\fR.
     84 .TP
     85 xwrite \fI<file>\fR \fI<data>\fR ...
     86 Writes each argument after \fI<file>\fR to the latter.
     87 
     88 
     89 .P
     90 Additionally, wmiir provides the following utility commands relevant
     91 to scripting wmii:
     92 
     93 .TP
     94 namespace
     95 
     96 .RS
     97 Prints the current wmii namespace directory, usually
     98 equivalent to /tmp/ns.\fB$USER\fR.\fB${DISPLAY\fR%.0\fB}\fR, but possibly
     99 different depending on the value of \fB$NAMESPACE\fR and
    100 \fB$WMII_NAMESPACE\fR.
    101 .RE
    102 
    103 .RS
    104 Synonyms: \fBns\fR
    105 .RE
    106 .TP
    107 setsid \fI[\-0 \fI<argv0>\fR]\fR \fI[\-f]\fR \fI<command>\fR
    108 
    109 .RS
    110 Executes the given command after setting the session id (see
    111 setsid(2)). If \fI\-0\fR is given, the command is run with the
    112 given value as argv\fI[0]\fR. For instance, to run sh as a login
    113 shell, one might run
    114 .RE
    115 
    116 .nf
    117          wmiir setsid -0 -sh sh
    118 .fi
    119 
    120 .RS
    121 If \fI\-f\fR is given, wmiir will fork into the background before
    122 executing the command.
    123 .RE
    124 .TP
    125 proglist \fI[\-\-]\fR \fI<directory>\fR ...
    126 
    127 .RS
    128 Lists all executable commands in the given directories.
    129 .RE
    130 
    131 .SH ENVIRONMENT
    132 .TP
    133 \fB$WMII_ADDRESS\fR
    134 The address at which to connect to wmii.
    135 .TP
    136 \fB$NAMESPACE\fR
    137 The namespace directory to use if no address is
    138 provided.
    139 
    140 
    141 .SH SEE ALSO
    142 .P
    143 wmii(1), libixp\fI[2]\fR
    144 
    145 .P
    146 \fI[1]\fR http://www.suckless.org/wiki/wmii/tips/9p_tips 
    147 .P
    148 \fI[2]\fR http://libs.suckless.org/libixp
    149 
    150 
    151 .\" man code generated by txt2tags 2.5 (http://txt2tags.sf.net)
    152 .\" cmdline: txt2tags -o- wmiir.man1
    153