https://github.com/ruby/etc
Provides access to information typically stored in UNIX /etc directory.
https://github.com/ruby/etc
hactoberfest ruby
Last synced: 5 months ago
JSON representation
Provides access to information typically stored in UNIX /etc directory.
- Host: GitHub
- URL: https://github.com/ruby/etc
- Owner: ruby
- License: other
- Created: 2017-04-11T08:56:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T03:58:09.000Z (6 months ago)
- Last Synced: 2025-04-01T08:29:36.740Z (6 months ago)
- Topics: hactoberfest, ruby
- Language: C
- Homepage:
- Size: 289 KB
- Stars: 30
- Watchers: 30
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Etc
The Etc module provides access to information typically stored in files in the /etc directory on Unix systems.
The information accessible consists of the information found in the `/etc/passwd` and `/etc/group` files, plus information about he system's temporary directory (/tmp) and configuration directory (/etc).
The Etc module provides a more reliable way to access information about the logged in user than environment variables such as +$USER+.
Read the [API RDoc](https://docs.ruby-lang.org/en/master/Etc.html).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'etc'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install etc
## Usage
```ruby
require 'etc'
login = Etc.getlogin
info = Etc.getpwnam(login)
username = info.gecos.split(/,/).first
puts "Hello #{username}, I see your login name is #{login}"
```
Note that the methods provided by this module are not always secure. It should be used for informational purposes, and not for security.
All operations defined in this module are class methods, so that you can include the Etc module into your class.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/etc.
## License
The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).