Skip to content
/ rdoc Public

A command-line tool for launching documents using your favorite PDF viewer, written in bash.

License

Notifications You must be signed in to change notification settings

yankh764/rdoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 

Repository files navigation

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:

    user # git clone https://github.com/yankh764/rdoc.git
  • Move to the cloned directory and type:

    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:

    user # rdoc
  • It'll display a help message, read it and then you are ready to go.

Contributing

Pull requests are welcomed and appreciated.

About

A command-line tool for launching documents using your favorite PDF viewer, written in bash.

Topics

Resources

License

Stars

Watchers

Forks

Languages