aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/utils
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2015-07-12 02:25:10 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2015-07-12 02:25:10 +0300
commit0abc54875342cc18a0be2bf3280343e552d6cd75 (patch)
tree9521669cc31588f899daa4ccce810d88a69cc252 /utils
parentadd_cert.bat: add certificates to the ROOT store (diff)
downloadwindows7-drivers-0abc54875342cc18a0be2bf3280343e552d6cd75.tar.gz
windows7-drivers-0abc54875342cc18a0be2bf3280343e552d6cd75.zip
README updates
Diffstat (limited to '')
-rw-r--r--utils/README.md16
-rw-r--r--utils/libnt_path_converter/README.md15
-rw-r--r--utils/libservice/README.md13
3 files changed, 27 insertions, 17 deletions
diff --git a/utils/README.md b/utils/README.md
index a106359..2f6072d 100644
--- a/utils/README.md
+++ b/utils/README.md
@@ -1,19 +1,23 @@
# Service management utilities
-Utilities used to manage (load, start, stop and unload) and communicate with drivers via virtual devices.
+Utilities used to manage (load, start, stop and unload) and communicate with
+drivers via virtual devices.
Usage examples of some of the drivers in this repository are also included.
-* [libservice](https://github.com/egor-tensin/windows_drivers/tree/master/utils/libservice) &mdash; a simple service management library.
+* [libservice](libservice) &mdash; a simple service management library.
Also includes means of communicating with a driver via virtual devices.
-* [libnt_path_converter](https://github.com/egor-tensin/windows_drivers/tree/master/utils/libnt_path_converter) &mdash; [nt_path_converter](https://github.com/egor-tensin/windows_drivers/tree/master/src/nt_path_converter) usage examples.
+* [libnt_path_converter](libnt_path_converter) &mdash;
+ [nt_path_converter](../src/nt_path_converter) usage examples.
## Building
-I've used the compiler shipped with Visual Studio Express 2013 with Update 4 for Windows Desktop.
+I've used the compiler shipped with Visual Studio Express 2013 with Update 4
+for Windows Desktop.
-You can generate the solution windows_drivers_utils.sln using CMake and build it using Visual Studio.
+You can generate the solution windows_drivers_utils.sln using CMake and build
+it using Visual Studio.
## Licensing
This project is licensed under the terms of the MIT License.
-See [Licensing](https://github.com/egor-tensin/windows_drivers#licensing) for details.
+See [Licensing](../README.md#licensing) for details.
diff --git a/utils/libnt_path_converter/README.md b/utils/libnt_path_converter/README.md
index 8d03e5c..b281d10 100644
--- a/utils/libnt_path_converter/README.md
+++ b/utils/libnt_path_converter/README.md
@@ -1,20 +1,23 @@
# libnt_path_converter
-[nt_path_converter](https://github.com/egor-tensin/windows_drivers/tree/master/src/nt_path_converter) usage examples.
+[nt_path_converter](../../src/nt_path_converter) usage examples.
## Usage
### libnt_path_converter.lib
-Wraps nt_path_converter's virtual device interface using [libservice](https://github.com/egor-tensin/windows_drivers/tree/master/utils/libservice).
-Include the headers by `#include`ing `include/libnt_path_converter/all.hpp`, which includes all of the other header files.
+Wraps nt_path_converter's virtual device interface using
+[libservice](../libservice).
+Include the headers by `#include`ing `include/libnt_path_converter/all.hpp`,
+which includes all of the other header files.
### convert_nt_path.exe
Usage: convert_nt_path.exe [NT_PATH...]
Converts a NT-style path to a DOS-style path.
-The NT namespace can be explored using the [WinObj](https://technet.microsoft.com/en-us/library/bb896657.aspx) utility.
+The NT namespace can be explored using the
+[WinObj](https://technet.microsoft.com/en-us/library/bb896657.aspx) utility.
Usage example (assuming nt_path_converter is already loaded):
>convert_nt_path.exe \Device\HarddiskVolume2\Windows
@@ -22,9 +25,9 @@ Usage example (assuming nt_path_converter is already loaded):
## Building
-See [Building](https://github.com/egor-tensin/windows_drivers/tree/master/utils#building).
+See [Building](../README.md#building).
## Licensing
This project is licensed under the terms of the MIT License.
-See [Licensing](https://github.com/egor-tensin/windows_drivers#licensing) for details.
+See [Licensing](../../README.md#licensing) for details.
diff --git a/utils/libservice/README.md b/utils/libservice/README.md
index a652f7b..c8dd180 100644
--- a/utils/libservice/README.md
+++ b/utils/libservice/README.md
@@ -6,11 +6,13 @@ Simple service management library and utilities.
### libservice.lib
-Clients may include the headers by `#include`ing `include/libservice/all.hpp`, which includes all of the other header files.
+Clients may include the headers by `#include`ing `include/libservice/all.hpp`,
+which includes all of the other header files.
For service management usage examples, see the utilities descriptions below.
-For virtual device usage examples, refer e.g. to [libnt_path_converter](https://github.com/egor-tensin/windows_drivers/tree/master/utils/libnt_path_converter).
+For virtual device usage examples, refer e.g. to
+[libnt_path_converter](../libnt_path_converter).
### install_service.exe
@@ -48,16 +50,17 @@ except that `stop_service.exe` waits until the service is actually stopped.
Usage: uninstall_service.exe NAME
-Uninstalls the service `NAME`, wiping the corresponding record from the registry.
+Uninstalls the service `NAME`, wiping the corresponding record from the
+registry.
The same as
sc delete NAME
## Building
-See [Building](https://github.com/egor-tensin/windows_drivers/tree/master/utils#building).
+See [Building](../README.md#building).
## Licensing
This project is licensed under the terms of the MIT License.
-See [Licensing](https://github.com/egor-tensin/windows_drivers#licensing) for details.
+See [Licensing](../../README.md#licensing) for details.