system/coreutils
system/coreutils
1
0
Fork 0
mirror of https://github.com/uutils/coreutils synced 2024-07-09 04:06:02 +00:00
Code Issues Projects Releases Wiki Activity
986d7cba79
coreutils/README.md
Arcterus 986d7cba79 Add some installation instructions
2014-06-12 19:14:56 -07:00

3.5 KiB
Raw Blame History

uutils coreutils Build Status

uutils is an attempt at writing universal (as in cross-platform) CLI utils in Rust. This repo is to aggregate the GNU coreutils rewrites.

Why?

Many GNU, Linux and other utils are pretty awesome, and obviously some effort has been spent in the past to port them to Windows. However, those projects are either old, abandoned, hosted on CVS, written in platform-specific C, etc.

Rust provides a good, platform-agnostic way of writing systems utils that are easy to compile anywhere, and this is as good a way as any to try and learn it.

Build Instructions

To simply build all available utilities:

make

To build all but a few of the available utilities:

make DONT_BUILD='UTILITY_1 UTILITY_2'

To build only a few of the available utilities:

make BUILD='UTILITY_1 UTILITY_2'

To build the multicall binary (i.e. BusyBox-like binary):

make MULTICALL=1

Installation Instructions

To install all available utilities:

make install

To install all but a few of the available utilities:

make DONT_INSTALL='UTILITY_1 UTILITY_2' install

To install only a few of the available utilities:

make INSTALL='UTILITY_1 UTILITY_2' install

To install the multicall binary:

make MULTICALL=1 install

To install every program (other than the multicall binary) with a prefix:

make PROG_PREFIX=PREFIX_GOES_HERE install

Uninstallation Instructions

Do the same command as in the Installation Instructions above, but replace install with uninstall.

Test Instructions

To simply test all available utilities:

make test

To test all but a few of the available utilities:

make DONT_TEST='UTILITY_1 UTILITY_2' test

To test only a few of the available utilities:

make TEST='UTILITY_1 UTILITY_2' test

Contribute

Contributions are very welcome, and should target Rust's master branch until Rust 1.0 is released. You may claim an item on the to-do list by following these steps:

  1. Open an issue named "Implement [the utility of your choice]", e.g. "Implement ls"
  2. State that you are working on this utility.
  3. Develop the utility.
  4. Submit a pull request and close the issue. Your pull request should include deleting the utility from the to-do list on this README.

The steps above imply that, before starting to work on a utility, you should search the issues to make sure no one else is working on it.

To do

  • chcon
  • chgrp
  • chmod
  • chown-core
  • chown
  • chroot
  • copy
  • cp (not much done)
  • cp-hash
  • csplit
  • cut
  • date
  • dd
  • df
  • dircolors
  • expand (in progress)
  • expr
  • extent-scan
  • find-mount-point
  • fmt
  • getlimits
  • group-list
  • install
  • join
  • lbracket
  • libstdbuf
  • link
  • ln
  • ls-dir
  • ls-ls
  • ls-vdir
  • ls
  • mkfifo
  • mknod
  • mktemp
  • mv
  • nice
  • nl
  • nohup
  • nproc
  • numfmt
  • od
  • operand2sig
  • pathchk
  • pinky
  • pr
  • printf
  • prog-fprintf
  • ptx
  • readlink
  • realpath
  • relpath
  • remove
  • runcon
  • setuidgid
  • shred
  • shuf
  • sort
  • split
  • stat
  • stdbuf
  • stty (in progress)
  • sync
  • tac-pipe
  • tail
  • test
  • timeout
  • tsort
  • uname-arch
  • uname-uname
  • unexpand
  • uniq (in progress)
  • who

License

uutils is licensed under the MIT License - see the LICENSE file for details