git://git.nikiroo.be / gofetch.git / blame
| Commit | Line | Data |
|---|---|---|
| 73785268 | 1 | # GoFetch |
| 73785268 | 2 | GoFetch is a simple web scrapper that outputs gopher-ready files. |
| 13229d5b NR |
3 | |
| 4 | ## Synopsis | |
| 5 | ||
| 6 | ```gofetch``` [*dir*] [*selector*] [*type*] [*max*] [*hostname*] [*port*] | |
| 7 | ||
| 8 | ## Description | |
| 9 | ||
| 10 | You point the program to your gopher directory, you launch it, and you have a | |
| 73785268 NR |
11 | gopher view of the supported news sites. |
| 12 | ||
| 13229d5b NR |
13 | The program will also helpfully create a ```gophermap``` and an ```index.html``` page for each supported website, as well as a general page to link to all the subpages (*selector*/```gophermap``` and *selector*/```index.html```). |
| 14 | ||
| 15 | ### Supported websites | |
| 73785268 NR |
16 | |
| 17 | - Slashdot: News for nerds, stuff that matters! | |
| 13229d5b NR |
18 | - Pipedot: News for nerds, without the corporate slant |
| 19 | - LWN: Linux Weekly Newsletter | |
| 20 | - Le Monde: Actualités et Infos en France et dans le monde | |
| 21 | - The Register: Biting the hand that feeds IT | |
| 22 | - TooLinux: Actualité généraliste sur Linux et les logiciels libres | |
| 23 | - Ère Numérique.FR: faites le bon choix ! | |
| 24 | - Phoronix: news regarding free and open-source software | |
| 73785268 | 25 | |
| 13229d5b | 26 | ### Supported platforms |
| 73785268 NR |
27 | |
| 28 | Any platform with at lest Java 1.6 on it should be ok. | |
| 29 | ||
| 13229d5b | 30 | ## Options |
| 73785268 | 31 | |
| b7f5700d NR |
32 | You can start the program via the script or directly with ```java```: |
| 33 | ||
| 13229d5b NR |
34 | - ```gofetch``` [*dir*] [*selector*] [*type*] [*max*] [*hostname*] [*port*] |
| 35 | - ```java -jar gofetch.jar``` [*dir*] [*selector*] [*type*] [*max*] [*hostname*] [*port*] | |
| 73785268 | 36 | |
| b7f5700d NR |
37 | The options are: |
| 38 | ||
| 13229d5b NR |
39 | - *dir*: the target directory where to store the files |
| 40 | - *selector*: the gopher selector to prepend (also a sub-directory in [dir]) | |
| 41 | - *type*: the supported website (see the ```Supported websites``` section) in upper case or the special keyword ```ALL``` for all of them | |
| 42 | - *max*: the maximum number of stories to show on the main page | |
| 43 | - *hostname*: the gopher hostname | |
| 44 | - *port*: the gopher port | |
| 73785268 NR |
45 | |
| 46 | ## Compilation | |
| 47 | ||
| 48 | ```./configure.sh && make``` | |
| 49 | ||
| 50 | You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there. | |
| 51 | ||
| 13229d5b | 52 | #### Dependant libraries (included) |
| 73785268 NR |
53 | |
| 54 | - libs/nikiroo-utils-sources.jar: some shared utility functions I also use elsewhere | |
| 55 | - [libs/jsoup-sources.jar](https://jsoup.org/): a nice library to parse HTML | |
| 56 | ||
| 57 | Nothing else but Java 1.6+. | |
| 58 | ||
| 59 | Note that calling ```make libs``` will export the libraries into the src/ directory. | |
| 60 | ||
| 13229d5b NR |
61 | ## Author |
| 62 | ||
| 63 | GoFetch was written by Niki Roo <niki@nikiroo.be> | |
| 64 |