Skip to content

Commit 2af7923

Browse files
committed
Updated README.
1 parent 1452286 commit 2af7923

File tree

1 file changed

+55
-1
lines changed

1 file changed

+55
-1
lines changed

README.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ Thanks to user `lazychris2000` here is a short instruction how to install the Ar
4040

4141
```
4242
c:
43-
cd \arsenal\cli\x64\aim_ll.exe --install ..\..
43+
cd \arsenal\cli\x64
44+
aim_ll.exe --install ..\..
4445
4546
```
4647

@@ -67,6 +68,59 @@ Finished successfully.
6768
You will need Delphi 7 and TNT-Unicode in order to compile the source code of **RamDiskUI** - or you can simply download the binary release.
6869
All pull requests are welcome.
6970

71+
## Explanation of the registry values
72+
73+
The RAM-disk UI (not the Arsenal driver) creates several registry values which are then picked up by the RAM-disk service (not in real-time unfortunately - only on **start** or **restart** of the service).
74+
They are created under `[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\ArsenalRamDisk]` and are explained below:
75+
76+
- `DiskSize` is the size in bytes
77+
- `DriveLetter` is obvious
78+
- `LoadContent` is path to a folder whose contents will be pre-loaded in the RAM-disk at startup
79+
- `ExcludeFolders` is StringList (lines delimited with CRLF) which specifies which folder names from the RAM-disk won't be saved on shutdown in the folder specified by `LoadContent`. I usually create numeric folders in my RAM-disk for my daily projects - but I don't want them to be persisted on disk because I can pull them with Git every morning.
80+
- `UseTempFolder` whether to create TEMP folder on RAM-disk and point the OS to this temp folder
81+
- `SyncContent` whether to save RAM-disk content on shutdown to the folder specified by `LoadContent`
82+
- `DeleteOld` whether to delete those files and folders from `LoadContent` which are not present on the RAM-disk on shutdown (meaningful only when `SyncContent` is TRUE)
83+
84+
Here is an example from my PC:
85+
86+
```
87+
Windows Registry Editor Version 5.00
88+
89+
[HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\services\ArsenalRamDisk]
90+
"DiskSize"="17179869184"
91+
"DriveLetter"="Z"
92+
"LoadContent"="D:\\Setup\\RAM_disk"
93+
"ExcludeFolders"="chrome
94+
opera
95+
phpstorm
96+
stoplight
97+
_
98+
0
99+
1
100+
2
101+
3
102+
4
103+
5
104+
6
105+
7
106+
8
107+
9"
108+
"UseTempFolder"=dword:00000001
109+
"SyncContent"=dword:00000001
110+
"DeleteOld"=dword:00000001
111+
"Type"=dword:00000010
112+
"Start"=dword:00000002
113+
"ErrorControl"=dword:00000001
114+
"ImagePath"=hex(2):44,00,3a,00,5c,00,53,00,4f,00,55,00,52,00,43,00,45,00,5c,00,\
115+
44,00,45,00,4c,00,46,00,49,00,5c,00,52,00,41,00,4d,00,64,00,69,00,73,00,6b,\
116+
00,5c,00,52,00,61,00,6d,00,53,00,65,00,72,00,76,00,69,00,63,00,65,00,2e,00,\
117+
65,00,78,00,65,00,00,00
118+
"DisplayName"="Arsenal RAM-disk"
119+
"WOW64"=dword:00000001
120+
"ObjectName"="LocalSystem"
121+
"Description"="Arsenal RAM-disk"
122+
```
123+
70124
# LICENSE
71125

72126
MIT License

0 commit comments

Comments
 (0)