Skip to content

Commit

Permalink
Update of the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sylvestre committed Feb 17, 2024
1 parent 31c57a1 commit 5689efa
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,43 @@
# procps
[![Crates.io](https://img.shields.io/crates/v/bsdutils.svg)](https://crates.io/crates/bsdutils)
[![Discord](https://img.shields.io/badge/discord-join-7289DA.svg?logo=discord&longCache=true&style=flat)](https://discord.gg/wQVJbvJ)
[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/uutils/bsdutils/blob/main/LICENSE)
[![dependency status](https://deps.rs/repo/github/uutils/bsdutils/status.svg)](https://deps.rs/repo/github/uutils/bsdutils)

[![CodeCov](https://codecov.io/gh/uutils/bsdutils/branch/master/graph/badge.svg)](https://codecov.io/gh/uutils/bsdutils)

# bsdutils
Rust reimplemtation of the bsdutils project

Provides command line tools:

- `/usr/bin/logger`: This command is used to add logs to the system log files. It provides a shell command interface to the syslog system log module.

Started:
- `/usr/bin/renice`: This command is used to change the priority of running processes. It can be used to increase or decrease the nice value of a process.

TODO:
- `/usr/bin/logger`: This command is used to add logs to the system log files. It provides a shell command interface to the syslog system log module.

- `/usr/bin/script`: This command is used to record a terminal session. The script makes a typescript of everything printed on your terminal.

- `/usr/bin/scriptlive`: This command is not standard, and may not be installed on all systems. If it exists, it's likely a variant of the `script` command that includes real-time features.

- `/usr/bin/scriptreplay`: This command is used to replay a terminal session that was recorded using the `script` command.

- `/usr/bin/wall`: This command is used to broadcast a message to all users logged into a system. The message can be typed directly into the terminal or read from a file.
- `/usr/bin/wall`: This command is used to broadcast a message to all users logged into a system. The message can be typed directly into the terminal or read from a file.

## Installation

Ensure you have Rust installed on your system. You can install Rust through [rustup](https://rustup.rs/).

Clone the repository and build the project using Cargo:

```bash
git clone https://github.com/uutils/bsdutils.git
cd bsdutils
cargo build --release
cargo run --release
```


## License

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

0 comments on commit 5689efa

Please sign in to comment.