JFLarvoire / SysToolsLib

A library of Windows and Linux system management tools
Apache License 2.0
329 stars 97 forks source link

System Tools Library

Project Description

System Tools

This Library contains many command-line tools for managing Windows and Unix (Ex: Linux, MacOS) systems. I've built them over 30 years, both for work at HP then HPE, and for home projects. Some of these tools have unique capabilities, that I hope Windows and Unix power users will find useful.

Major highlights:

For a list of available tools and their description, see Catalog.md.

Development Libraries

This Library also contains several software libraries that developers could find useful: As many tools shared common features, I've refactored them many times. The common code is now in libraries, which can be reused in new programs and scripts.

Major highlights:

For more details on these C libraries, see C/README.md, and the README.md files in the C/ subdirectories.

Programming languages:

Old tools were mostly written in C/C++. Then I started using scripting languages more often: Batch and PowerShell for Windows-only tools; Python and Tcl for cross-OS tools; Shell for Unix-only tools.

Jean-François Larvoire jf.larvoire@free.fr 2024-06-11

Installation

Scripts and programs in Windows

You can use the WIN32 release files on all versions of Windows.

You can also rebuild all C programs from sources. More details about this further down.

Scripts and programs in Unix

The C programs need to be rebuilt from source. As for scripts, only the Shell and Tcl directories contain useful scripts in Unix.

Development environment

The C development environment is designed so that a Windows and a Unix system (possibly one a VM inside the other) can share the same sources, and output executables in distinct target-OS-specific subdirectories.

Files description

See the README.txt or README.md file in each subdirectory for more details about that particular library, and further subdirectories.

Name Description
C/ Programs and libraries written in C or C++
Batch/ Scripts and libraries in the Batch language
Docs/ Project documentation
PowerShell/ Scripts and libraries in the PowerShell language
Python/ Scripts and libraries in or for the Python language
Shell/ Scripts and libraries in the Posix Shell language
Shell/profile.d/ Posix Shell initialization scripts to install into /etc/profile.d
Tcl/ Scripts and libraries in or for the Tcl language

Particular files:

Name Description
README.md This file
NEWS.md Project history
LICENSE.txt Project license (Apache 2.0)
*.lst List of files that go into source or binary releases. Used by MakeZip.bat and make release.

Tools Usage

All tools (both scripts and C programs) support the -? option for help, and most share a few other common options:

Option Description
-? Display a help screen. (In Unix shells that swallow ? characters, use the -h alias)
   
-d Display debug information: Help the author understand what code is running.
-v Display verbose information: Help users understand what the program is doing.
-V Display the script version and exit.
-X No Exec mode: Display what the program would do, but don't do it.
   
-A Force ANSI encoding output. (Windows only)
-O Force OEM encoding output. (Windows only)
-U Force UTF8 encoding output. (Windows only)

All make files support a make help target, which displays a help screen with available make variables and targets.

Contributing

Most of the development work was done by Jean-François Larvoire during work hours at HP then HPE. It is thus now HPE that is the copyright owner of this code. HPE legal authorized in March 2016 for a first part, October 2016 for a second part, and February 2017 for the last part, the open-source release of this code, provided that future contributors agree with the following conditions:

License

Copyright 2016-2020 Hewlett Packard Enterprise

All files in this distribution are licensed under the Apache License version 2.0. You may not use any of these files except in compliance with this License. You may obtain a copy of the Apache License version 2.0 at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under this License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing its permissions and limitations.