From 31d217b37594562fd13c696dfbfdae38caa0b624 Mon Sep 17 00:00:00 2001 From: Jose Narvaez Date: Wed, 8 Nov 2017 23:22:25 +0000 Subject: [PATCH] README and docs tweaks. --- README.md | 20 +++++++++++++------- src/lib.rs | 11 +++++------ 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 573a365a29..a0de2e5b74 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,19 @@ -# Redox OS userutils +# Redox OS user and group utilities. -This repository contains utilities for user and group management for Redox. Additional related tools are included. +The `userutils` crate contains the utilities for dealing with users and groups in Redox OS. +They are heavily influenced by UNIX and are, when needed, tailored to specific Redox use cases. + +These implementations strive to be as simple as possible drawing particular +inspiration by BSD systems. They are indeed small, by choice. [![Travis Build Status](https://travis-ci.org/redox-os/userutils.svg?branch=master)](https://travis-ci.org/redox-os/userutils) **Currently included:** -- `getty` -- `id` -- `login` -- `sudo` -- `whoami` +- `getty`: Used by `init(8)` to open and initialize the TTY line, read a login name and invoke `login(1)`. +- `id`: Displays user identity. +- `login`: Allows users to into the system +- `passwd`: Allows users to modify their passwords. +- `su`: Allows users to substitute identity. +- `sudo`: Enables users to execute a command as another user. +- `whoami`: Display effective user ID. \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index f7f8a98799..dcb18c0f55 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,19 +1,18 @@ //! Redox OS user and group utilities. //! -//! The `userutils` crate is contains the utilities for dealing with users and groups in Redox OS. -//! They are heavily influenced by UNIX and are, when nedeed, tailored to specific Redox use cases. +//! The `userutils` crate contains the utilities for dealing with users and groups in Redox OS. +//! They are heavily influenced by UNIX and are, when needed, tailored to specific Redox use cases. //! //! These implementations strive to be as simple as possible drawing particular //! inspiration by BSD systems. They are indeed small, by choice. //! //! The included utilities are: //! -//! - `getty`: Used by `init(8)` to open and initialize the TTY line, read a login name, -//! and invoke `login(1)`. +//! - `getty`: Used by `init(8)` to open and initialize the TTY line, read a login name and invoke `login(1)`. //! - `id`: Displays user identity. -//! - `login`: Allows users to into the system +//! - `login`: Allows users to into the system. //! - `passwd`: Allows users to modify their passwords. -//! - `su`: Allows users to sustitute identity. +//! - `su`: Allows users to substitute identity. //! - `sudo`: Enables users to execute a command as another user. //! - `whoami`: Display effective user ID.