GnuGetOpt 1.1.3

GnuGetOpt

C#.NET port of Java port of GNU getopt from glibc 2.0.6

Installation

dotnet add package GnuGetOpt

Usage

Short options

Parse command-line options using a format string where each character is a valid option. A colon after a character means the option requires an argument. Two colons mean the argument is optional.

using Gnu.Getopt;

var g = new Getopt("myapp", args, "ab:c::d");

int c;
while ((c = g.getopt()) != -1)
{
    switch (c)
    {
        case 'a':
        case 'd':
            Console.WriteLine("Option: " + (char)c);
            break;

        case 'b':
        case 'c':
            Console.WriteLine("Option: " + (char)c + " Arg: " + g.Optarg);
            break;

        case '?':
            // getopt() already printed an error
            break;
    }
}

// Remaining non-option arguments
for (int i = g.Optind; i < args.Length; i++)
{
    Console.WriteLine("Argument: " + args[i]);
}

$ myapp -a -b value -d file1 file2
Option: a
Option: b Arg: value
Option: d
Argument: file1
Argument: file2

Long options

Define long options using LongOpt objects. Each long option maps to a short option character or a custom integer value.

using Gnu.Getopt;
using System.Text;

var longopts = new LongOpt[]
{
    new LongOpt("help", Argument.No, null, 'h'),
    new LongOpt("output", Argument.Required, null, 'o'),
    new LongOpt("verbose", Argument.No, null, 'v'),
};

var g = new Getopt("myapp", args, "ho:v", longopts);

int c;
while ((c = g.getopt()) != -1)
{
    switch (c)
    {
        case 'h':
            Console.WriteLine("Help requested");
            break;
        case 'o':
            Console.WriteLine("Output: " + g.Optarg);
            break;
        case 'v':
            Console.WriteLine("Verbose mode");
            break;
    }
}

$ myapp --verbose --output=result.txt input.txt
Verbose mode
Output: result.txt

Option string format

Properties

Breaking changes in 1.0.0

Nullable reference types

All projects now have <Nullable>enable</Nullable>. Properties that can be null are annotated:

• Getopt.Optarg is now string?
• LongOpt constructor flag parameter accepts StringBuilder?

Renamed types (ConsoleApplication only)

The demo application types were renamed to follow .NET conventions:

Namespace changes (ConsoleApplication only)

Removed legacy CI

AppVeyor, Travis CI, and Coveralls configurations have been removed. CI/CD is now handled entirely by GitHub Actions.

License

BSD-2-Clause