Command line modified cp command.
Mycp has not produced any errors so far on UNIX systems. It has been designed and tested on Ubuntu Flavour version 23.10 x86_64.
If you face a situation full of errors, please contact the maintainers.
- Features
- Requirements
- Installation
- Basic usage
- Alternative usage (Optional)
- Error codes
- Reporting bugs
- License
- Authors
Mycp provides the following features:
- File copying with standard I/O buffer.
- File copying with a user-specified buffer.
- Timing of the copy operation for the file/files.
- Easy error detection.
-
Unix based OS's
- GCC Compiler
- makefile
Clone the above repository locally on your computer, open the src folder, run the command 'make' in the terminal, and finally, execute the command ./mycp.
After a successful cloning and compiling, the command to execute it:
./mycp
This will display the usage of mycp program's window with a list of options.
If you wish to use the command with the default I/O buffer you need to issue the following on your terminal:
./mycp <source_file> <destination>
If you wish to use the command with the user-specified buffer you need to issue the following on your terminal:
./mycp -b<buffer_size> <source_file> <destination>
If you prefer not to use the command via ./mycp, there is also an alternative usage:
-
You need to save the
srcfolder to a specific location within your system where you believe it won't be altered. -
Open the terminal within the directory
srcand issue the following commandpwd, it will display the current working directory, showing the full path. -
Copy the full path that the terminal displayed to you and open another terminal window.
-
Issue the command:
nano ~/.bashrcto insert the path from the mycp file. -
Insert the following command at the end of the file (.bashrc):
export PATH=$PATH:/home/username/mycp
Warning: You need to replace the username with the name you are using!
-
After issuing the above command, press
CTRL + Oto save, then pressENTER, and finally, pressCTRL + Xto exit the .bashrc file. -
Finally, execute the following command:
source ~/.bashrcto update the .bashrc file so that you can run themycpcommand.
Mycp has an integrated error system with numerical codes. Each code corresponds to a string explaining the error. Below, you will find the table of possible errors:
| Exit code | Description |
|---|---|
| 0 | SUCCESS |
| 1 | INSUFFICIENT ARGUMENTS |
| 2 | INVALID BUFFER SIZE |
| 3 | UNABLE TO OPEN SOURCE FILE |
| 4 | UNABLE TO CREATE DESTINATION FILE |
| 5 | UNABLE TO CREATE REPORT.OUT |
| 6 | UNABLE TO ALLOCATE MEMORY |
| 7 | INSUFFICIENT DISK SPACE |
| 8 | ERROR IN STATVFS |
| 9 | INSUFFICIENT AVAILABLE DISK SPACE |
Exit Code 0: If your program returns exit code 0 after execution, it means that it ran without any issues. :D
Exit Code 1: In the event that your program returns exit code 1 after execution, it means that you haven't provided the correct arguments during the execution of 'mycp.' Specifically:
-
You misspelled the
mycpcommand. -
The number of arguments you provided was not 3 or 4 (3 for standard I/O buffer, 4 for a given buffer size).
Exit Code 2: In the event that your program returns exit code 2 after execution, it means that the buffer size you provided is not able to used during the execution of 'mycp.' Specifically:
-
The buffer size exceeds the available memory size of your system.
-
Misspelled the "-b" before the buffer size.
Exit Code 3: In the event that your program returns exit code 3 after execution, it means that the process of opening the <source_file> was unsuccessful during the execution of 'mycp.' Specifically:
-
You may have given wrong path for the file.
-
You may have not the permissions to read the file.
-
The file you provided does not exist in your system at all.
Exit Code 4: In the event that your program returns exit code 4 after execution, it means that the creation of <report.out> was unsuccessful during the execution of 'mycp.' Specifically:
-
You may not have enough space in your system.
-
You may have tried to create it in a directory for which you do not have permissions.
-
You may have tried to overwrite a file for which you do not have permissions.
Exit Code 5: In the event that your program returns exit code 5 after execution, it means that the creation of <report.out> was unsuccessful during the execution of 'mycp.' Specifically:
-
You may not have enough space in your system.
-
You may have tried to create it in a directory for which you do not have permissions.
-
You may have tried to overwrite a file for which you do not have permissions.
Exit Code 6: In the event that your program returns exit code 6 after execution, it means that the allocation of memory for the buffer was unsuccessful during the execution of 'mycp.' Specifically:
- You may have provided a buffer size larger than the available memory in your system.
Exit Code 7: In the event that your program returns exit code 7 after execution, it means that your disk space was insufficient for the execution of 'mycp.'
Exit Code 8: In the event that your program returns exit code 8 after execution, it means that the process of obtaining information about the file system was unsuccessful during the execution of 'mycp.'
Exit Code 9: In the event that your program returns exit code 9 after execution, it means that the availabe space in your disk was not enough for the creation of the files needed during the execution of 'mycp.'
When a bug is found, please do report it by opening an issue at github, as already stated above.
In your report you should, at the very least, state your Linux version, GCC version, Kernel version and CPU version (x86 or x64) of installation.
A simple screenshot of your terminal output would be preferable by issuing the following command: neofetch
Warning: As you can see in the above screenshot, it does not include the correct information required because the program is running on a virtual machine and cannot display the real components of the computer.
MIT License
Copyright (c) 2023 Spyros Kokotos & Christos Karydis
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
The above program is a creation of Christos Karydis - inf2022076@ionio.gr & Spyros Kokotos - inf2021098@ionio.gr, and you can use it for your personal projects or further develop it as long as you always give credit to the creators.