Skip to content

Commit 1d5fd0e

Browse files
committed
Update Readme to v0.3.0
1 parent cdbe1c0 commit 1d5fd0e

File tree

1 file changed

+53
-13
lines changed

1 file changed

+53
-13
lines changed

README.md

Lines changed: 53 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,29 @@ As a concept, M2em has different workers that run in a loop. All Chapter/user da
4646
* Converter - Converting images into ebooks
4747
* Sender - Compiling & Sending Emails to users and marking them as SENT
4848

49-
With the sourceparser you can add support of a Webhost.
49+
50+
### The Loop Run & Daemon Loop Run
51+
If you start m2em in loop mode (with or without --daemon) it will only consider any action with elements that that are
52+
younger than 24h hours.
53+
54+
The use of that is having it running on the server 24/7, waiting for updates from the feeds and ONLY handling said updates.
55+
56+
### Direct action
57+
You can start a part of the loop without the restriction of 24h. Use the -a (--action) command with either element you wish to start.
58+
59+
Example: if you wish to download all chapters you have saved in your database, you start the download action.
60+
```
61+
./m2em.py --action downloader
62+
```
63+
### Chapter action
64+
You can directly apply an action to one chapter with the options --download, --convert or --send. You need to pass
65+
the ID of said chapter, you can find that out with "-Lc" or "-lc".
66+
You can pass multiple IDs.
67+
Example:
68+
```
69+
./m2em.py --download 100 #Downloads chapter with ID 100
70+
```
71+
5072

5173
## Supported Websites
5274
* Mangastream
@@ -56,10 +78,11 @@ With the sourceparser you can add support of a Webhost.
5678

5779
### Help output:
5880
```
59-
usage: m2em.py [-h] [-af ADD_FEED] [-au] [-lc] [-Lc] [-lf] [-lu] [-cd] [-a]
60-
[-s] [-ss SWITCH_SEND] [-sc SWITCH_CHAPTER]
61-
[-dc DELETE_CHAPTER] [-du DELETE_USER] [-df DELETE_FEED]
62-
[--daemon] [-d]
81+
usage: m2em.py [-h] [-af ADD_FEED] [-au] [-lc] [-Lc] [-lf] [-lu] [-cd] [-s]
82+
[--send [SEND [SEND ...]]] [--convert [CONVERT [CONVERT ...]]]
83+
[--download [DOWNLOAD [DOWNLOAD ...]]] [-a ACTION]
84+
[-ss SWITCH_SEND] [-sc SWITCH_CHAPTER] [-dc DELETE_CHAPTER]
85+
[-du DELETE_USER] [-df DELETE_FEED] [--daemon] [-d] [-v]
6386
6487
Manga to eManga - m2em
6588
@@ -75,10 +98,19 @@ optional arguments:
7598
-lf, --list-feeds Lists all feeds
7699
-lu, --list-users Lists all Users
77100
-cd, --create-db Creates DB. Uses Configfile for Naming
78-
-a, --action Start action. Options are: rss (collecting feed data),
79-
downloader, converter or sender
80-
-s, --start Start a single loop. If no arguments are passed, a
81-
single loop will also start
101+
-s, --start Starts one loop
102+
--send [SEND [SEND ...]]
103+
Sends Chapter directly by chapter ID. Multiple IDs can
104+
be given
105+
--convert [CONVERT [CONVERT ...]]
106+
Converts Chapter directly by chapter ID. Multiple IDs
107+
can be given
108+
--download [DOWNLOAD [DOWNLOAD ...]]
109+
Downloads Chapter directly by chapter ID. Multiple IDs
110+
can be given
111+
-a ACTION, --action ACTION
112+
Start action. Options are: rssparser (collecting feed
113+
data), downloader, converter or sender
82114
-ss SWITCH_SEND, --switch-send SWITCH_SEND
83115
Pass ID of User. Switches said user Send eBook status
84116
-sc SWITCH_CHAPTER, --switch-chapter SWITCH_CHAPTER
@@ -91,6 +123,8 @@ optional arguments:
91123
Pass ID of Feed. Deletes said Feed
92124
--daemon Run as daemon
93125
-d, --debug Debug Mode
126+
-v, --version show program's version number and exit
127+
94128
```
95129

96130
## Initial Data
@@ -132,13 +166,20 @@ ServerStartSSL = True
132166

133167
To start a single run through the workers, you can simply execute the main program:
134168
```
135-
./m2em.py
169+
./m2em.py -s
136170
```
137171

138-
If you wish to run the program as a daemon, start it with the option "--daemon". It will re-run at the config "Sleep" in second.
172+
If you wish to run the program as a daemon, start it with the option "--daemon" as well. It will re-run at the config "Sleep" in second.
139173
```
140-
./m2em.py --daemon
174+
./m2em.py -s --daemon
175+
```
176+
177+
If you wish to disable/enable sending status of a user, use the -ss command
141178
```
179+
./m2em.py -ss <USERID>
180+
```
181+
182+
142183

143184
### A complete run with nothing happening:
144185
```
@@ -159,7 +200,6 @@ Finished sending ebooks!
159200
Everything else should be self-explanatory with the "-h" option.
160201

161202
## Known Issues
162-
* There is a huge data load in the beginning. It is recommended to only activate sending of Emails after one complete run
163203
* MangaFox has issues with SSL Verification on some systems. For now, Simply add the http feed.
164204

165205
Please Open an issue if you find anything!

0 commit comments

Comments
 (0)