diff options
author | Egor Tensin <Egor.Tensin@gmail.com> | 2016-06-25 05:00:42 +0300 |
---|---|---|
committer | Egor Tensin <Egor.Tensin@gmail.com> | 2016-06-25 05:00:42 +0300 |
commit | 7430065810eada05a168874bb28e9972f7ecea76 (patch) | |
tree | 254bc665d9573c6cb7439c0f05886de53a573a2d | |
parent | README updates (diff) | |
download | windows7-drivers-7430065810eada05a168874bb28e9972f7ecea76.tar.gz windows7-drivers-7430065810eada05a168874bb28e9972f7ecea76.zip |
README updates
Diffstat (limited to '')
-rw-r--r-- | README.md | 18 | ||||
-rw-r--r-- | utils/README.md | 11 | ||||
-rw-r--r-- | utils/libnt_path_converter/README.md | 9 | ||||
-rw-r--r-- | utils/libservice/README.md | 9 | ||||
-rw-r--r-- | utils/libtest/README.md | 31 |
5 files changed, 52 insertions, 26 deletions
@@ -1,4 +1,5 @@ -# Windows 7 drivers +Windows 7 drivers +================= A collection of basic Windows 7 drivers. @@ -6,7 +7,8 @@ These are actually not drivers as such in the sense that they don't actually manage any hardware. The author prefers calling them *kernel modules*. -## Development +Development +----------- ### Prerequisites @@ -72,7 +74,8 @@ source directory to `clean_driver.bat`: clean_driver.bat C:\workspace\personal\windows7-drivers\src\test -## Installation +Installation +------------ To install a driver as a Windows service, you can use the `sc` utility. For example, to install `test.sys` as a service with the name `test`, execute: @@ -100,7 +103,8 @@ Using the `bcdedit` utility, execute and restart your computer. -## Remote debugging +Debugging +--------- A driver can be debugged using WinDbg. To enable kernel debugging, you can use the `msconfig` utility (navigate to @@ -123,14 +127,16 @@ You can then connect to the pipe from a WinDbg instance on the host OS (via "File" -> "Kernel Debug..."). Refer to your virtualization software's documentation for details. -## Utilities +Utilities +--------- A couple of usages examples are included along with the drivers. For details, see [Utilities]. [Utilities]: utils/README.md -## License +License +------- This project, including all of the files and their contents, is licensed under the terms of the MIT License. diff --git a/utils/README.md b/utils/README.md index eed64ab..b03c4c1 100644 --- a/utils/README.md +++ b/utils/README.md @@ -1,4 +1,5 @@ -# Driver utilities +Driver utilities +================ A couple of usage examples are included along with the drivers. @@ -12,7 +13,8 @@ A couple of usage examples are included along with the drivers. [libnt_path_converter]: libnt_path_converter/README.md [nt_path_converter]: ../src/nt_path_converter -## Building the utilities +Building the utilities +---------------------- Create the build files using CMake and build using Visual Studio. @@ -28,8 +30,9 @@ x86): > msbuild windows7_drivers_utils.sln ... -## License +See also +-------- -See [License]. +* [License] [License]: ../README.md#license diff --git a/utils/libnt_path_converter/README.md b/utils/libnt_path_converter/README.md index b3cde53..b5830d6 100644 --- a/utils/libnt_path_converter/README.md +++ b/utils/libnt_path_converter/README.md @@ -1,10 +1,12 @@ -# nt_path_converter driver utilities +nt_path_converter driver utilities +================================== [nt_path_converter] driver usage examples. [nt_path_converter]: ../../src/nt_path_converter -## Usage +Usage +----- ### convert_nt_path.exe @@ -19,7 +21,8 @@ For example: [WinObj]: https://technet.microsoft.com/en-us/library/bb896657.aspx -## See also +See also +-------- * [Building the utilities] * [License] diff --git a/utils/libservice/README.md b/utils/libservice/README.md index 2727f31..f9fb601 100644 --- a/utils/libservice/README.md +++ b/utils/libservice/README.md @@ -1,8 +1,10 @@ -# Driver management utilities +Driver management utilities +=========================== Utilities to load/unload the drivers. -## Usage +Usage +----- ### install_service.exe @@ -41,7 +43,8 @@ The same as > sc delete NAME -## See also +See also +-------- * [Building the utilities] * [License] diff --git a/utils/libtest/README.md b/utils/libtest/README.md index ddab9ce..0257c71 100644 --- a/utils/libtest/README.md +++ b/utils/libtest/README.md @@ -1,29 +1,40 @@ -# test driver utilities +test driver utilities +===================== [test] driver usage examples. [test]: ../../src/test -## Usage +Usage +----- ### exchange_ints.exe - Usage: exchange_ints.exe N +``` +Usage: exchange_ints.exe N +``` Parses its argument as an `unsigned int` and exchanges it with the one stored in [test] driver's memory. For example: - > exchange_ints.exe 1 - 42 +``` +> exchange_ints.exe 1 +42 +``` - > exchange_ints.exe 32 - 1 +``` +> exchange_ints.exe 32 +1 +``` - > exchange_ints.exe 100500 - 32 +``` +> exchange_ints.exe 100500 +32 +``` -## See also +See also +-------- * [Building the utilities] * [License] |