summaryrefslogtreecommitdiff
path: root/manual.txt
diff options
context:
space:
mode:
authorakiyamn2020-09-10 18:13:12 +1000
committerakiyamn2020-09-10 18:13:12 +1000
commit03e396142909f633ddc201e7c948bfc71319a0d2 (patch)
tree816ff170bb70044908fd69e99296cea2922b213b /manual.txt
parentcc006cf8239efd4f30925a1cefb0e408db3ffe0d (diff)
downloadfit2100_ass1-03e396142909f633ddc201e7c948bfc71319a0d2.tar.gz
fit2100_ass1-03e396142909f633ddc201e7c948bfc71319a0d2.zip
Split into two files1.0.0-rc1
Diffstat (limited to 'manual.txt')
-rw-r--r--manual.txt23
1 files changed, 22 insertions, 1 deletions
diff --git a/manual.txt b/manual.txt
index f0be81c..d0475f3 100644
--- a/manual.txt
+++ b/manual.txt
@@ -4,16 +4,37 @@ Fileutil is a program which is a utility for files written in C. It combines the
It allows you to copy or move the contents of a given file to stdout or to a another file.
You can also choose whether or not to overwrite the destination file if it exists.
+Please note that all paths given to this program must be absolute, UNIX style file paths.
+(i.e. start with '/' or '~')
+
+COMPILATION:
+
+ This program can be easily compiled using the make command. Simply run the command:
+
+ make
+
+ in the main directory and the executable fileutil will be created. You need to have GNU Make on your system to compile in this way.
+
+
SYNOPSIS:
+ fileutil
fileutil SOURCE
fileutil SOURCE [OPTIONS] -d DEST
+
+PARAMETERS:
+ SOURCE The absolute path to the source file to be moved or copied.
+ If one isn't provided, then it is set to "logfile.txt" by default.
+ DEST The path to the destination directory of the copy/move operation.
+ If one isn't provided, it prints to stdout (i.e. the terminal output) instead.
+
+
OPTIONS:
OPTION ARGUMENT(S) DESCRIPTION
-d DEST Specifies the path (DEST) of the output directory
-M Move the file from its destination rather than copying it
- -F Allows the program to overwrite a file if it already exists (must be used with -d) \ No newline at end of file
+ -F Allows the program to overwrite a file if it already exists (must be used with -d)