Merge pull request #135 from fkautz/pr_out_command_list

docs/commands/minio-get.md

@@ -0,0 +1,17 @@
+% MINIO(1) Minio Manual
+% Minio
+% December 2014
+# NAME
+minio-get - Get an object from the store.
+
+# SYNOPSIS
+**minio get**
+BUCKET OBJECTPATH
+
+# DESCRIPTION
+Gets an object from a given BUCKET at the given OBJECTPATH. The object is
+returned on the standard output stream (STDOUT)
+
+# EXAMPLES
+
+    $ minio get images /favorites/example.png > local_image.png

docs/commands/minio-init.md

@@ -0,0 +1,17 @@
+% MINIO(1) Minio Manual
+% Minio
+% December 2014
+# NAME
+minio-init - Initialize a new minio repository.
+
+# SYNOPSIS
+**minio init**
+BUCKET
+
+# DESCRIPTION
+Initialize a new bucket. BUCKET is the name of the new bucket.
+
+# EXAMPLES
+
+    $ minio init images
+

docs/commands/minio-put.md

@@ -0,0 +1,19 @@
+% MINIO(1) Minio Manual
+% Minio
+% December 2014
+# NAME
+minio-put - Put an object into the store.
+
+# SYNOPSIS
+**minio put**
+BUCKET OBJECTPATH [FILE]
+
+# DESCRIPTION
+Adds an object to a given BUCKET at the given OBJECTPATH. An optional FILE may
+be provided. If no FILE is provided, the standard input stream (STDIN) is used
+instead.
+
+# EXAMPLES
+
+    $ minio put images /favorites/example.png local_image.png
+    $ minio put images /favorites/example2.png < local_image2.png

docs/internal/commands.md

@@ -0,0 +1,42 @@
+User Commands
+=============
+* put [bucket] [path] [file]
+* put [bucket] [path] < stdin
+* get [bucket] [path] > stdout
+* verify-bucket [bucket]
+* verify-object [bucket] [path]
+* fix-bucket [bucket]
+* fix-object [bucket] [path]
+
+stderr prints json on error
+
+System Commands
+===============
+* initialize-repo
+* split-stream
+* merge-stream
+* encode
+* decode
+* add-to-index
+* add-to-store
+* get-from-index
+* get-from-store
+* crc
+* md5sum-stream
+* verify-repo
+* verify-object
+* whitelist-failure
+
+Potential Workflow Pseudocode (single pass)
+=============================
+```sh`
+add /bucket/name local-file
+    localFile : io.Reader = open(file)
+    md5sum-stream localFile
+    chunks = split-file localFile
+    for each chunk in chunks:
+        encode chunk
+        crc chunk
+        add-to-store name,chunk,length,crc
+    add-to-index name,chunkcount,md5,ts
+```