wsllib

README

wsllib-go

A WSL Library for Golang.

Usage

Get this package

go get github.com/yuk7/wsllib-go

Example

package main

import "github.com/sarvex/wsllib-go"

func main() {
    wsllib.WslLaunchInteractive("DistroName", "", true)
}

Notes

WslLaunchInteractive is not used in this library as it causes problems in goroutine.

Instead, a function is defined to connect stdin, stdout, stderr to WslLaunch.

Documentation

Index

• Constants
• func WslConfigureDistribution(distributionName string, defaultUID uint64, wslDistributionFlags uint32) (err error)
• func WslGetDistributionConfiguration(distributionName string) (distributionVersion uint32, defaultUID uint64, flags uint32, err error)
• func WslIsDistributionRegistered(distributionName string) bool
• func WslLaunch(distributionName string, command string, useCurrentWorkingDirectory bool, ...) (process syscall.Handle, err error)
• func WslLaunchInteractive(distributionName string, command string, useCurrentWorkingDirectory bool) (exitCode uint32, err error)
• func WslRegisterDistribution(distributionName, tarGzFilename string) error
• func WslUnregisterDistribution(distributionName string) error

Constants

const (
	//FlagEnableInterop is flag of interop feature
	FlagEnableInterop = 1
	//FlagAppendNTPath is flag of appending windows path
	FlagAppendNTPath = 2
	//FlagEnableDriveMounting is flag of mounting windows drive
	FlagEnableDriveMounting = 4
	//FlagEnableWsl2 is flag of enabled wsl2, read only
	FlagEnableWsl2 = 8
)

Functions

func WslConfigureDistribution

func WslConfigureDistribution(distributionName string, defaultUID uint64, wslDistributionFlags uint32) (err error)

WslConfigureDistribution configures distribution configuration

func WslGetDistributionConfiguration

func WslGetDistributionConfiguration(distributionName string) (distributionVersion uint32, defaultUID uint64, flags uint32, err error)

WslGetDistributionConfiguration gets distribution configuration

func WslIsDistributionRegistered

func WslIsDistributionRegistered(distributionName string) bool

WslIsDistributionRegistered determines if a distribution is already registered

func WslLaunch

func WslLaunch(distributionName string, command string, useCurrentWorkingDirectory bool, stdIn syscall.Handle, stdOut syscall.Handle, stdErr syscall.Handle) (process syscall.Handle, err error)

WslLaunch launches the distribution with handle

func WslLaunchInteractive

func WslLaunchInteractive(distributionName string, command string, useCurrentWorkingDirectory bool) (exitCode uint32, err error)

WslLaunchInteractive launches the distribution with interactive shell

func WslRegisterDistribution

func WslRegisterDistribution(distributionName, tarGzFilename string) error

WslRegisterDistribution registers a new distribution

func WslUnregisterDistribution

func WslUnregisterDistribution(distributionName string) error

WslUnregisterDistribution unregisters the specified distribution