https://github.com/yankh764/rdoc
A command-line tool for launching documents using your favorite PDF viewer, written in bash.
https://github.com/yankh764/rdoc
bash bash-script command-line-tool documents linux reading
Last synced: about 2 months ago
JSON representation
A command-line tool for launching documents using your favorite PDF viewer, written in bash.
- Host: GitHub
- URL: https://github.com/yankh764/rdoc
- Owner: yankh764
- License: gpl-3.0
- Created: 2021-05-06T21:02:41.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-13T10:42:04.000Z (about 5 years ago)
- Last Synced: 2025-05-21T20:12:31.486Z (about 1 year ago)
- Topics: bash, bash-script, command-line-tool, documents, linux, reading
- Language: Shell
- Homepage:
- Size: 34.2 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rdoc - A command-line tool for launching documents
This bash script is dedicated for all the Linux readers whom spend all their time working on the terminal;
therefore they launch everything from there.
If you are the kind of person I described above, I believe that this tool would benefit you.
This script purposes are to help you launch documents using your favorite PDF Viewer, which will
save you a lot of time if you have lots of documents like me.
## Requirements and Dependencies
1. Bash
2. GNU Core Utilities
3. grep
4. A PDF Viewer
5. A directory that contains all your documents.
Note: The first 3 dependencies should be already installed by default on most linux distros.
## Installation
* Make sure all the previous dependencies are installed and all the requirements are implemented.
* Clone this repo by typing:
```Bash
user # git clone https://github.com/yankh764/rdoc.git
```
* Move to the cloned directory and type:
```Bash
root # cp rdoc /usr/local/bin/rdoc
root # chmod 755 /usr/local/bin/rdoc
```
Note: You can copy the program to wherever you wish but it is recomendded to keep it in your **PATH**.
## Usage
* If you did the previous installation steps you can run the program from terminal simply by typing:
``` Bash
user # rdoc
```
* It'll display a help message, read it and then you are ready to go.
## Contributing
Pull requests are welcomed and appreciated.