Skip to content

ic-coders-club/wol

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wol

Wol is named for Owl in Winnie the Pooh (by A. A. Milne).

And he respects Owl, because you can't help respecting anybody who can spell TUESDAY, even if he doesn't spell it right; but spelling isn't everything. There are days when spelling Tuesday simply doesn't count.

Rabbit, speaking of Christopher Robin

It is a packge to manage arXiv papers (and now you can add other pdfs) This prevents multiple copies of the same paper in Downloads, and gives them named that are easier to remember than 1234.3532. Wol can also allows searching, opening of files and opening a paper's arXiv page in a browser at the type of a word or two. The user can move queried files to different directories which serves as a method of tagging.

The title is automatically quieried from the internet, and if an arXiv number is given (rather than a filename), the paper will be downloaded.

Only supports pdfs.

Usage

  1. Basic, you can guess these:

     $ wol help
     $ wol info
    
  2. Add an arXiv paper to directory dir, directory is optional, otherwise goes into default directory:

     $ wol add *????.????* dir
    
  3. Delete an arXiv paper:

     $ wol del 1111.1111
    
  4. Configuration show or edit

     $ wol config
    
  5. Add another dotwol file:

     $ wol addwol newdotwol
    
  6. Find papers that match regexp expression:

     $ wol find thing
     $ wol find        # displays all
    
  7. Move all files that match a find:

     $ wol mv *????.????* new_directory
    
  8. Update, just checks all is well

     $ wol update
    
  9. Show, displays (upto a maximum) number of files that match a criteria:

     $ wol show thing
    
  10. Show arXiv page in browser, (upto a maximum) number of files that match a criteria:

     $ wol browse thing
    
  11. Put, add any pdf, must give 3 arguments:

    $ wol put /path/to/file.pdf "Title of the file" dir
    

ArXiv files are usually of the form 1234.5678, but they can also be of the form name/1234567. These are also supported, use (for example) wol add hep-ph/1234567 for these.

Installation

  1. Get the package from github:

     $ git clone https://github.com/hippyPig/wol
    
  2. Simply put /wol in your chosen path.

  3. Run ./install.sh from directory

    1. This simply sets the default WOLDIR to ~/Documents/Wol

    2. This is put in your .bashrc:

       $ export WOLDIR=/path/to/where/to/put/files
       $ export PATH=$PATH:/path/to/wol
       $ source /path/to/wol/wol-autocomplete.sh  # for autocompletion of args
      
  1. GO!

License

Distributed under The MIT License, Copyright (c) 2014 Samuel C. P. Hall

    , ,
   (o,o)
  ./)``)
----"-"---<_

Releases

No releases published

Packages

No packages published