| dhendrix@google.com | 17bee8a | 2010-06-15 01:41:24 +0000 | [diff] [blame] | 1 | mosys - The multifunction open system tool |
| 2 | |
| 3 | Introduction |
| 4 | ------------ |
| 5 | Mosys is designed to aid in obtaining obscure system-specific information |
| 6 | and present it in a uniform, human-friendly manner that is also parseable. It |
| 7 | is intended to complement other systems software and may overlap in some areas. |
| 8 | |
| 9 | Examples of information this program is useful for: |
| 10 | - Platform identification |
| 11 | - Snapshot of machine information |
| 12 | - Listing non-enumerable devices |
| 13 | - Retrieving vital product data |
| 14 | |
| 15 | Due to the system-specific nature of this program, it is unlikely to work with |
| 16 | most platforms. A generic subset of functionality will be available, though |
| 17 | its usefulness may be extremely limited. |
| 18 | |
| 19 | Configuration & Building |
| 20 | ------------------------ |
| 21 | Mosys uses the Linux kernel configuration and build system. "make help" lists |
| 22 | the available configuration and build targets. |
| 23 | |
| dhendrix@google.com | 8a8bbca | 2010-07-01 03:38:39 +0000 | [diff] [blame] | 24 | After a fresh checkout, you will need to generate a configuration file before |
| 25 | the sources may be compiled. To do so, run a configuration target (ie "make |
| 26 | menuconfig") followed by a generic target such as "make" or "make all". |
| dhendrix@google.com | 17bee8a | 2010-06-15 01:41:24 +0000 | [diff] [blame] | 27 | |
| 28 | Usage |
| 29 | ----- |
| 30 | Mosys uses a natural language syntax to navigate thru a command hierarchy for |
| 31 | a given platform. Each supported platform will have a specific set of commands |
| 32 | available. |
| 33 | |
| 34 | Typically, top-level commands will reflect classes of hardware components |
| 35 | such as "cpu" or "sensor", available busses such as "pci" or "i2c", or a |
| 36 | type of information such as "smbios" or "vpd". |
| 37 | |
| 38 | Mosys returns EXIT_SUCCESS upon successful completion of a command, or |
| 39 | EXIT_FAILURE if a command is not supported on a given platform. These values |
| 40 | are defined in the system's stdlib.h. In case of failure, mosys will also print |
| 41 | a message to stderr to let the user know. |
| 42 | |
| 43 | Use "mosys -t" to display the command tree for the host platform. |