Skip to content

Commit f30dae8

Browse files
pagabucjtsylve
authored andcommitted
documentation of the timeout parameter (Fixes #27)
* documentation of the timeout parameter * Update README
1 parent 3dde260 commit f30dae8

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,24 @@ LiME utilizes the insmod command to load the module, passing required arguments
2020
insmod ./lime.ko "path=<outfile | tcp:<port>> format=<raw|padded|lime> [dio=<0|1>]"
2121
2222
path (required): outfile ~ name of file to write to on local system (SD Card)
23-
tcp:port ~ network port to communicate over
23+
tcp:port ~ network port to communicate over
2424
2525
format (required): raw ~ concatenates all System RAM ranges
26-
padded ~ pads all non-System RAM ranges with 0s
27-
lime ~ each range prepended with fixed-size header containing address space info
26+
padded ~ pads all non-System RAM ranges with 0s
27+
lime ~ each range prepended with fixed-size header containing address space info
2828
2929
dio (optional): 1 ~ attempt to enable Direct IO
30-
0 ~ default, do not attempt Direct IO
30+
0 ~ default, do not attempt Direct IO
3131
32-
localhostonly (optional): 1 restricts the tcp to only listen on localhost, 0 binds on all interfaces (default)
32+
localhostonly (optional): 1 ~ restricts the tcp to only listen on localhost,
33+
0 ~ binds on all interfaces (default)
34+
35+
timeout (optional): 1000 ~ max amount of milliseconds tolerated to read a page (default).
36+
If a page exceeds the timeout all the memory region are skipped.
37+
0 ~ disable the timeout so the slow region will be acquired.
38+
39+
This feature is only available on kernel versions >= 2.6.35.
40+
3341
```
3442

3543
## Examples <a name="example"/>

0 commit comments

Comments
 (0)