Skip to content

Commit

Permalink
Added some details.
Browse files Browse the repository at this point in the history
  • Loading branch information
whitwham committed Nov 30, 2015
1 parent 56a8c61 commit 289f835
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# tears
Stream files to and from iRODS
Stream files to and from iRODS.

tears either reads from stdin and writes a file to iRODS or reads a file from iRODS and writes to stdout. Basic usage for writing is:

file_making_program | tears /path/to/irods/file

or for reading:

tears -r /path/to/irods/file | file_receiving_program

Two things to note. Firstly, tears will try to pick the best iRODS host to read or write from. This can cause authentication problems and can be switched off by using the -d option. Secondly, the iRODS file can be in the form of a URI (proposed [here](https://github.com/samtools/htslib/issues/229)). The URI is of the form:

irods://[irodsUserName%23irodsZone@][irodsHost][:irodsPort]/collection_path/data_object





0 comments on commit 289f835

Please sign in to comment.