cuqmbr/netxml2kml
1
0
Fork 0
Code Issues Pull Requests Activity

docs: update README.md

Browse Source 
Add 'Cammand examples' & 'Data storage folder' section
This commit is contained in:
cuqmbr 2022-08-24 12:56:13 +03:00 committed by GitHub
parent 2ab9e7ce98
commit 7c72a88bd0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -29,13 +29,22 @@ Reference [this](https://docs.microsoft.com/en-us/dotnet/core/deploying/) page t
NOTE:
- RID – [runtime identifier](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog) of a targeted platform
- ~ – project root directory
- RID – [runtime identifier](https://docs.microsoft.com/en-us/dotnet/core/rid-catalog) of a targeted platform
<!--## How to tweak this project for your own uses?
-->
## Cammand examples
- Convert .netxml to .kml: `$ netxml2kml -i *path_to_netxml_file* -o *path_to_output_file*`
- Add wireless networks with related wireless connections (clients) to database: `$ netxml2kml -di *path_to_netxml_file*`
- Additionally you can filter input data: `$ netxml2kml -di *path_to_netxml_file* -q *sql_query*`
- Retrieve wireless networks with related wireless connections (clients) from database: `$ netxml2kml -do *path_to_output_file*`
- You can filter output data similarly to filtering input data: `$ netxml2kml -do *path_to_output_file* -q *sql_query*`
- Concatenate multiple .kml files: `$ netxml2kml -c *pathes_to_kml_files_separated_by_spaces* -o *path_to_output_file*`
## SQL querying reference
This section will help you to understand database structure the program uses ang give you examples of filtering input/output data using SQL queries
@ -44,8 +53,7 @@ This section will help you to understand database structure the program uses ang
Select wireless networks where:
- column name matching some pattern:
`SELECT * FROM WirelessNetworks WHERE *column name* LIKE '%*pattern*%'`
- column name matching some pattern: `SELECT * FROM WirelessNetworks WHERE *column name* LIKE '%*pattern*%'`
- clients with a specific manufacturer has been spotted:
```
@ -77,6 +85,14 @@ Reference [this](https://www.sqlitetutorial.net/) tutorial to learn more about v
\----------------------/
</pre>
## Data storage folder
Acording to [this](https://jimrich.sk/environment-specialfolder-on-windows-linux-and-os-x/) website program data (database and logs) are stored in netxml2kml folder at:
- Linux: /home/$USER/.local/share
- OSX: /Users/$USER/.local/share
- Windows: C:\Users\%USERNAME%\AppData\Local
## How to contribute?
If you want to add a feature, you should follow these steps: