Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / cfc9a89aae080d89d3184e75d5ba6c4edd02d071
commitcfc9a89aae080d89d3184e75d5ba6c4edd02d071[log] [tgz]
authorChris Smart <chris@distroguy.com>Mon Oct 24 15:55:16 2016 +1100
committerJoel Stanley <joel@jms.id.au>Mon Oct 24 16:00:34 2016 +1030
tree58cf7a2c7960da174cfd66e7c877ea0a50c56b83
parent44580de4e2170c8ee06dbf401315d3acfcf52b22 [diff]
doc: README updates

Make it more clear on how to build and run the programs.

Change-Id: I5d35b797ac98ca6071f251ea0ca37fe057478697
Signed-off-by: Chris Smart <chris@distroguy.com>
Signed-off-by: Joel Stanley <joel@jms.id.au>
1 file changed
tree: 58cf7a2c7960da174cfd66e7c877ea0a50c56b83
  1. test/
  2. .travis.yml
  3. bootstrap.sh
  4. config.c
  5. configure.ac
  6. console-client.c
  7. console-server.c
  8. console-server.h
  9. console-socket.c
  10. LICENSE
  11. log-handler.c
  12. Makefile.am
  13. obmc-console.conf.sample
  14. README.md
  15. socket-handler.c
  16. tty-handler.c
  17. util.c
README.md

To Build

Note: In addition to a toolchain and autoconf tools, this requires autotools-archive to be installed.

To build this project, run the following shell commands:

./bootstrap.sh
./configure ${CONFIGURE_FLAGS}
make

To fully clean the repository, run:

./bootstrap.sh clean

To Run Server

Running the server requires a serial port (e.g. /dev/ttyS0):

touch obmc-console.conf
./obmc-console-server --config obmc-console.conf ttyS0

To Connect Client

To connect to the server, simply run the client:

./obmc-console-client

To disconnect the client, use the standard ~. combination.