lsi

README

lsi

Follow elements of a file path

lsi is a Go library module and command-line utility for analyzing file paths. It clones the same functionality as the namei utility from the util-linux package, whose manpage accurately describes lsi as well:

lsi interprets its arguments as pathnames to any type of Unix file (symlinks, files, directories, and so forth). lsi then follows each path‐name until an endpoint is found (a file, a directory, a device node, etc). If it finds a symbolic link, it shows the link, and starts following it, indenting the output to show the context.

Usage

Running lsi without any flags or arguments will simply print the path components from your current directory, one per line:

$ lsi
/
home
andrew

To view a long listing for each of the path components, similar to ls -l from GNU Coreutils, use the -l flag:

$ lsi -l
drwxr-xr-x   root   root 4096 @ /
drwxr-xr-x   root   root 4096   home
drwxr-xr-x andrew andrew 4096   andrew

Notice that the -l flag also indicates whether an individual component represents a mount point using the @ symbol preceding the file name. Therefore, in the above example, we can be confident all of these files exist on the same physical device.

By default, symlinks encountered are followed up until the two paths coincide, and each level of indirection is represented by indentation preceding the file name. Multiple paths may be specified at once:

$  lsi -l /bin/vi /proc/self/exe
-- /bin/vi
drwxr-xr-x root root    4096 @ /
lrwxrwxrwx root root       7   bin -> usr/bin
drwxr-xr-x root root    4096     usr
drwxr-xr-x root root  135168     bin
lrwxrwxrwx root root      20   vi -> /etc/alternatives/vi
drwxr-xr-x root root    4096 @   /
drwxr-xr-x root root   12288     etc
drwxr-xr-x root root   12288     alternatives
lrwxrwxrwx root root      13     vi -> /usr/bin/nvim
drwxr-xr-x root root    4096 @     /
drwxr-xr-x root root    4096       usr
drwxr-xr-x root root  135168       bin
-rwxrwxr-x root root 3469640       nvim

-- /proc/self/exe
drwxr-xr-x   root      root    4096 @ /
dr-xr-xr-x   root      root       0 @ proc
lrwxrwxrwx   root      root       0   self -> 4069059
dr-xr-xr-x andrew    andrew       0     4069059
lrwxrwxrwx andrew    andrew       0   exe -> /usr/local/go/bin/lsi
drwxr-xr-x   root      root    4096 @   /
drwxr-xr-x   root      root    4096     usr
drwxrwsr-x   root developer    4096     local
drwxrwsr-x andrew developer    4096     go
drwxrwsr-x andrew developer    4096     bin
-rwxrwxr-x andrew developer 2871632     lsi

Use the -h flag for a summary of all options available:

usage:
  lsi [flags] [--] [PATH ...]

flags:
  -v  Display version information.
  -a  Display change history.
  -n  Do not follow symlinks.
  -l  Output using long format (-p -u -g -s -m).
  -p  Output file type and permissions.
  -u  Output file owner.
  -g  Output file group.
  -s  Output file size (bytes).
  -i  Output file inode.
  -m  Output mount point symbols (@).

Installation

Use the builtin Go package manager:

go get -v github.com/ardnew/lsi/cmd/lsi

Documentation

Index

• Variables
• func Walk(path string, fn WalkFunc) error
• type Component
  • func MakeComponent(from, path, volume, name string, level int) Component
  • func (c *Component) FmtName() string
  • func (c *Component) String() string
• type WalkFunc

Variables

var IndentWidth = 2

Functions

func Walk

func Walk(path string, fn WalkFunc) error

Types

type Component

type Component struct {
	Path   string
	Volume string
	Name   string
	Link   string
	Mode   string
	Dev    uint64
	Pdev   uint64
	Inode  uint64
	Size   int64
	Uid    int
	User   string
	Gid    int
	Group  string
	Level  int
	Info   os.FileInfo
	Err    error
}

func MakeComponent

func MakeComponent(from, path, volume, name string, level int) Component

func (*Component) FmtName

func (c *Component) FmtName() string

func (*Component) String

func (c *Component) String() string

type WalkFunc

type WalkFunc func(c Component) (follow bool, err error)