[gofetch.git] / README.md

# GoFetch
GoFetch is a simple web scrapper that outputs gopher-ready files.

## Synopsis

```gofetch``` [*dir*] [*selector*] [*type*] [*max*] [*hostname*] [*port*]

## Description

You point the program to your gopher directory, you launch it, and you have a
gopher view of the supported news sites.

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```).

### Supported websites

- Slashdot: News for nerds, stuff that matters!
- Pipedot: News for nerds, without the corporate slant
- LWN: Linux Weekly Newsletter
- Le Monde: Actualités et Infos en France et dans le monde
- The Register: Biting the hand that feeds IT
- TooLinux: Actualité généraliste sur Linux et les logiciels libres
- Ère Numérique.FR: faites le bon choix !
- Phoronix: news regarding free and open-source software

### Supported platforms

Any platform with at lest Java 1.6 on it should be ok.

## Options

- ```gofetch``` [*dir*] [*selector*] [*type*] [*max*] [*hostname*] [*port*]
- ```java -jar gofetch.jar``` [*dir*] [*selector*] [*type*] [*max*] [*hostname*] [*port*]

- *dir*: the target directory where to store the files
- *selector*: the gopher selector to prepend (also a sub-directory in [dir])
- *type*: the supported website (see the ```Supported websites``` section) in upper case or the special keyword ```ALL``` for all of them
- *max*: the maximum number of stories to show on the main page
- *hostname*: the gopher hostname
- *port*: the gopher port

## Compilation

```./configure.sh && make```

You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there.

#### Dependant libraries (included)

- libs/nikiroo-utils-sources.jar: some shared utility functions I also use elsewhere
- [libs/jsoup-sources.jar](https://jsoup.org/): a nice library to parse HTML

Nothing else but Java 1.6+.

Note that calling ```make libs``` will export the libraries into the src/ directory.

## Author

GoFetch was written by Niki Roo <niki@nikiroo.be>
Commit	Line	Data
	1	# GoFetch
	2	GoFetch is a simple web scrapper that outputs gopher-ready files.
	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
	11	gopher view of the supported news sites.
	12
	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
	16
	17	- Slashdot: News for nerds, stuff that matters!
	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
	25
	26	### Supported platforms
	27
	28	Any platform with at lest Java 1.6 on it should be ok.
	29
	30	## Options
	31
	32	- ```gofetch``` [dir] [selector] [type] [max] [hostname] [port]
	33	- ```java -jar gofetch.jar``` [dir] [selector] [type] [max] [hostname] [port]
	34
	35	- dir: the target directory where to store the files
	36	- selector: the gopher selector to prepend (also a sub-directory in [dir])
	37	- type: the supported website (see the ```Supported websites``` section) in upper case or the special keyword ```ALL``` for all of them
	38	- max: the maximum number of stories to show on the main page
	39	- hostname: the gopher hostname
	40	- port: the gopher port
	41
	42	## Compilation
	43
	44	```./configure.sh && make```
	45
	46	You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there.
	47
	48	#### Dependant libraries (included)
	49
	50	- libs/nikiroo-utils-sources.jar: some shared utility functions I also use elsewhere
	51	- [libs/jsoup-sources.jar](https://jsoup.org/): a nice library to parse HTML
	52
	53	Nothing else but Java 1.6+.
	54
	55	Note that calling ```make libs``` will export the libraries into the src/ directory.
	56
	57	## Author
	58
	59	GoFetch was written by Niki Roo <niki@nikiroo.be>
	60