wmii

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

wmiir.man1 (3092B)

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