mirror of https://github.com/lsd-rs/lsd synced 2024-11-10 14:24:27 +00:00

Andrey Cherkashin a01b20fb7f doc: Add FreeBSD installation instructions

I've recently submitted port to FreeBSD's ports tree and my PR was merged today. That means from now on this application can be installed from binaries on FreeBSD.

On the side note: I can setup CI for FreeBSD if you wan. Let me know and i will submit a PR.

2020-05-31 15:10:14 +05:30

5.3 KiB

Raw Blame History

LSD (LSDeluxe)

Description
Screenshot
Installation
Configurations
- Required
- Optional
F.A.Q.
Contributors
Credits

Description

This project is heavily inspired by the super colorls project but with some little differences. For example it is written in rust and not in ruby which makes it much faster.

Screenshot

Installation

Prerequisites

Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at the Nerd Font README for more installation instructions. Don't forget to setup your terminal in order to use the correct font.

See this issue comment for detailed instructions on how to configure iTerm2 font settings correctly.

On Archlinux

pacman -S lsd

On Fedora

dnf install lsd

On Ubuntu

... and other Debian-based Linux distributions

Download the latest .deb package from the release page and install it via:

sudo dpkg -i lsd_7.2.0_amd64.deb  # adapt version number and architecture

On Gentoo

sudo emerge sys-apps/lsd

(Ebuild maintained by Georgy Yakovlev)

From Snap

sudo snap install lsd

On macOS

via Homebrew:

brew install lsd

On NixOS/From nix

nix-env -iA nixos.lsd

Or add lsd to your configuration.nix like so:

# ...
environment.systemPackages = with pkgs; [
  # other packages ...
  lsd
];
# ...

On FreeBSD

pkg install lsd

From Sources

With Rust's package manager cargo, you can install lsd via:

cargo install lsd

If you want to install the latest master branch commit:

cargo install --git https://github.com/Peltoche/lsd.git --branch master

From Binaries

The release page includes precompiled binaries for Linux and macOS.

Configurations

Required

Enable nerd fonts for your terminal, URxvt for example:

.Xresources

URxvt*font:    xft:Hack Nerd Font:style=Regular:size=11

Optional

In order to use lsd when entering the ls command, you need to add this to your shell configuration file (~/.bashrc, ~/.zshrc, etc.):

alias ls='lsd'

Some further examples of useful aliases:

alias l='ls -l'
alias la='ls -a'
alias lla='ls -la'
alias lt='ls --tree'

F.A.Q.

Default Colors

In the future the possibility to customize the colors might be implemented. For now, the default colors are:

User/Group	Permissions	File Types	Last time Modified	File Size
User	Read	Directory	within the last hour	Small File
Group	Write	Executable File	within the last day	Medium File
	Execute	Non-Executable File	older	Large File
	Execute with Stickybit	Broken Symlink		Non File
	No Access	Pipe/Symlink/Blockdevice/Socket/Special
		CharDevice