aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/utils
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2016-05-20 21:26:26 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2016-05-20 21:26:26 +0300
commit96872487d024fed9cb089fa876ccf2c9e960874a (patch)
treef70723882a9b2e3ee0a502de0f9d897b6d8416ec /utils
parentREADME update (diff)
downloadwindows7-drivers-96872487d024fed9cb089fa876ccf2c9e960874a.tar.gz
windows7-drivers-96872487d024fed9cb089fa876ccf2c9e960874a.zip
README updates
Diffstat (limited to '')
-rw-r--r--utils/README.md36
-rw-r--r--utils/libnt_path_converter/README.md35
-rw-r--r--utils/libservice/README.md44
-rw-r--r--utils/libtest/README.md33
4 files changed, 76 insertions, 72 deletions
diff --git a/utils/README.md b/utils/README.md
index c69617e..7dcf890 100644
--- a/utils/README.md
+++ b/utils/README.md
@@ -1,24 +1,30 @@
-# Service management utilities
+# Driver utilities
-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.
+A few usage examples are provided along with the drivers.
+Those include:
-* [libservice](libservice) &mdash; a simple service management library.
- Also includes means of communicating with a driver via virtual devices.
-* [libnt_path_converter](libnt_path_converter) &mdash;
- [nt_path_converter](../src/nt_path_converter) usage examples.
-* [libtest](libtest) &mdash; [test](../src/test) usage examples.
+* [libservice]: utilities to easily install/start/stop/uninstall drivers
+ (using Windows services),
+* [libtest]: [test] driver usage examples,
+* [libnt_path_converter]: [nt_path_converter] usage examples.
## Building
-I've used the compiler shipped with Visual Studio Express 2013 with Update 4
-for Windows Desktop.
+To build the utilities:
-You can generate the solution windows7_drivers_utils.sln using CMake and build
-it using Visual Studio.
+1. generate the solution windows7_drivers_utils.sln using CMake,
+2. build the solution using Visual Studio.
-## Licensing
+## License
This project is licensed under the terms of the MIT License.
-See [Licensing](../README.md#licensing) for details.
+See [License] for details.
+
+
+
+[license]: ../README.md#license
+[libservice]: libservice/README.md
+[libtest]: libtest/README.md
+[test]: ../src/test
+[libnt_path_converter]: libnt_path_converter/README.md
+[nt_path_converter]: ../src/nt_path_converter
diff --git a/utils/libnt_path_converter/README.md b/utils/libnt_path_converter/README.md
index e401aaa..43375e0 100644
--- a/utils/libnt_path_converter/README.md
+++ b/utils/libnt_path_converter/README.md
@@ -1,33 +1,36 @@
-# libnt_path_converter
+# nt_path_converter driver utilities
-[nt_path_converter](../../src/nt_path_converter) usage examples.
+[nt_path_converter] driver usage examples.
-## Usage
+## Library
-### libnt_path_converter.lib
+[nt_path_converter] driver's virtual device is wrapped into a separate library
+`libnt_path_converter` using [libservice].
+`#include <libnt_path_converter/all.hpp>` and link with
+`libnt_path_converter.lib` to use the library.
-Wraps `nt_path_converter`'s virtual device interface using
-[libservice](../libservice).
-Include the headers by `#include`ing `libnt_path_converter/all.hpp`, which
-includes all the other header files.
+## Utilities
### 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.
-Usage example (assuming `nt_path_converter` is already loaded):
+The NT namespace can be explored using the [WinObj] utility.
+For example:
> convert_nt_path.exe \Device\HarddiskVolume2\Windows
C:\Windows
-## Building
+## See also
-See [Building](../README.md#building).
+* [Building]
+* [License]
-## Licensing
-This project is licensed under the terms of the MIT License.
-See [Licensing](../../README.md#licensing) for details.
+
+[building]: ../README.md#building
+[license]: ../../README.md#license
+[nt_path_converter]: ../../src/nt_path_converter
+[libservice]: ../libservice/README.md
+[WinObj]: https://technet.microsoft.com/en-us/library/bb896657.aspx
diff --git a/utils/libservice/README.md b/utils/libservice/README.md
index 8e25c2e..22c9388 100644
--- a/utils/libservice/README.md
+++ b/utils/libservice/README.md
@@ -1,39 +1,32 @@
-# libservice
+# Service management utilities
-Simple service management library and utilities.
+Utilities to easily install/start/stop/uninstall drivers using Windows
+services.
-## Usage
+## Library
-### libservice.lib
+`#include <libservice/all.hpp>` and link with `libservice.lib` to use the
+library.
-Include the headers by `#include`ing `libservice/all.hpp`, which includes all
-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](../libnt_path_converter).
+## Utilities
### install_service.exe
Usage: install_service.exe NAME SYS_PATH
Installs a driver as a service.
-The service is started manually.
The same as
- sc create NAME type= kernel binPath= SYS_PATH
+ > sc create NAME type= kernel binPath= SYS_PATH
### start_service.exe
Usage: start_service.exe NAME
-Starts a service (loading the corresponding driver).
+Starts the service `NAME` (loading the corresponding driver).
The same as
- net start NAME
-
-except that `start_service.exe` waits until the service is actually loaded.
+ > net start NAME
### stop_service.exe
@@ -42,9 +35,7 @@ except that `start_service.exe` waits until the service is actually loaded.
Stops the service `NAME` (unloading the corresponding driver).
The same as
- net stop NAME
-
-except that `stop_service.exe` waits until the service is actually stopped.
+ > net stop NAME
### uninstall_service.exe
@@ -54,13 +45,14 @@ Uninstalls the service `NAME`, wiping the corresponding record from the
registry.
The same as
- sc delete NAME
+ > sc delete NAME
+
+## See also
-## Building
+* [Building]
+* [License]
-See [Building](../README.md#building).
-## Licensing
-This project is licensed under the terms of the MIT License.
-See [Licensing](../../README.md#licensing) for details.
+[building]: ../README.md#building
+[license]: ../../README.md#license
diff --git a/utils/libtest/README.md b/utils/libtest/README.md
index dae0cfe..4992849 100644
--- a/utils/libtest/README.md
+++ b/utils/libtest/README.md
@@ -1,22 +1,22 @@
-# libtest
+# test driver utilities
-[test](../../src/test) usage examples.
+[test] driver usage examples.
-## Usage
+## Library
-### libtest.lib
+[test] driver's virtual device is wrapped into a separate library `libtest`
+using [libservice].
+`#include <libtest/all.hpp>` and link with `libtest.lib` to use the library.
-Wraps `test`'s virtual device interface using [libservice](../libservice).
-Include the headers by `#include`ing `libtest/all.hpp`, which includes all the
-other header files.
+## Utilities
### exchange_ints.exe
Usage: exchange_ints.exe N
-Parses a given `unsigned int` and exchanges it with the value stored in
-driver's memory.
-Usage example (assuming `test` is already loaded):
+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
@@ -27,11 +27,14 @@ Usage example (assuming `test` is already loaded):
> exchange_ints.exe 100500
32
-## Building
+## See also
-See [Building](../README.md#building).
+* [Building]
+* [License]
-## Licensing
-This project is licensed under the terms of the MIT License.
-See [Licensing](../../README.md#licensing) for details.
+
+[building]: ../README.md#building
+[license]: ../../README.md#license
+[test]: ../../src/test
+[libservice]: ../libservice/README.md