summaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorAaron Ball <nullspoon@oper.io>2018-11-14 10:51:50 -0700
committerAaron Ball <nullspoon@oper.io>2018-11-14 11:58:49 -0700
commit0c3363d807f591c9054f5bdabe501bf6bf67ace1 (patch)
treed24b980b25d4a4055345eb451b2f30c13e001b6c /README.adoc
downloadsegment-file-master.tar.gz
segment-file-master.tar.xz
Initial commitHEADmaster
This includes the readme, license, and the bash implementation of the file segmenter.
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
new file mode 100644
index 0000000..ceaec6b
--- /dev/null
+++ b/README.adoc
@@ -0,0 +1,25 @@
+README
+======
+
+Various implementations of a file segmenter. Note that all of these preserve
+the original file after segmentation.
+
+
+file-segment.sh
+---------------
+
+Bash implementation. Takes two arguments: **filename** and **segment count**.
+
+Usage
+~~~~~
+
+ file-segment.sh <filename.txt> <segment_count>
+
+
+Example
+~~~~~~~
+
+ file-segment.sh /var/log/messages 8
+
+This example will create an **out** directory containing 8 segments of the file
+/var/log/messages.

Generated by cgit