readme.txt 912 B

1234567891011121314151617181920212223242526272829303132333435363738
  1. ssf - simple system fetcher
  2. ===============================
  3. ssf prints a small set of system facts next to a coloured ASCII logo to stdout.
  4. The code keeps to plain POSIX interfaces so it runs on Linux and OpenBSD.
  5. Requirements
  6. ------------
  7. A POSIX environment with a C99 compiler and make(1).
  8. Installation
  9. ------------
  10. Edit config.mk to match your local setup (ssf installs into /usr/local
  11. by default). Afterwards run:
  12. make
  13. make install
  14. Usage
  15. -----
  16. Simply run ssf with no arguments for the standard display. Optional
  17. flags mimic the original interface:
  18. -m print values without labels
  19. -s print a short subset of fields
  20. -k print only the value for a specific key
  21. -h show usage help
  22. -v show the version string
  23. Customisation
  24. -------------
  25. ASCII definitions live in the ascii file and can be edited to taste.
  26. Feature toggles, compiler flags, and install paths are configured through
  27. config.mk.