aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.gitignore3
-rw-r--r--:65
2 files changed, 66 insertions, 2 deletions
diff --git a/.gitignore b/.gitignore
index 9d08c7b..a3d7f26 100644
--- a/.gitignore
+++ b/.gitignore
@@ -115,5 +115,4 @@ matched.txt
cookies.txt
regions.txt
randopfiles/
-
-
+':'
diff --git a/: b/:
new file mode 100644
index 0000000..c21d7a2
--- /dev/null
+++ b/:
@@ -0,0 +1,65 @@
+.TH randopitons "05 Nov. 2018" "ver 0.1"
+
+.SH NAME
+randopitons.sh - A script for downloading hitchiking files from https://randopitons.re.
+
+.SH SYNOPSIS
+
+.B randopitons.sh
+[
+.B -lm / --list-maptype
+]
+[
+.B -lr / --list-regions
+]
+
+.B randopitons.sh
+[
+.B -u / --username
+"youremail@forrandopitons.re" ]
+
+.B randopitons.sh
+[
+.B -u / --username
+"youremail@forrandopitons.re" ]
+[
+.B -r / --region "a region"
+]
+
+.B randopitons.sh
+[
+.B -u / --username
+"youremail@forrandopitons.re" ]
+[
+.B -a / --all
+]
+
+
+.SH SYNOPSIS
+.B randopitons.sh
+[
+.B -u / --username
+"youremail@forrandopitons.re" ]
+
+.SH DESCRIPTION
+You will need to make an account on the website before using the script.
+The following regions are valid: cilaos, salazie, mafate, est, nord, ouest, sud, volcan, ailleurs. Case insensitive.
+
+.SH EXAMPLES
+
+Log in with the -u switch :
+
+ $ ./randopitons.sh -u lionelmiquel@sfr.fr
+ Your username is lionelmiquel@sfr.fr. (You can press CTRL+C to cancel the script if this info is incorrect).
+ Password (for randopitons.re):
+
+If successfull, a cookie file should have been generated and you can then start downloading. But first list the regions if you don't know what part of La RĂ©union to download.
+
+ $ ./randopitons.sh -
+
+.SH BUGS
+Report to Miquel Lionel at <lionelmiquel@sfr.fr>. Thanks you !
+
+.SH AUTHORS
+Lionel Miquel
+.B <lionelmiquel@sfr.fr>.