Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / obmc-console / 1b5750109ef3a365e2c60b112ad35a48f690fbee
commit1b5750109ef3a365e2c60b112ad35a48f690fbee[log] [tgz]
authorJeremy Kerr <jk@ozlabs.org>Wed Feb 08 11:22:23 2017 +0800
committerJeremy Kerr <jk@ozlabs.org>Tue Jun 27 14:55:02 2017 +0800
tree4baa7e2dc8bf01e0808ddf67aab03352b8a52fe7
parent55c9712de99f56f575bfa6e49f85ab2c62538984 [diff]
server: Add documentation to struct handler

Add a little documentation for the handler API, as we'll be changing
this with upcoming buffer code.

Change-Id: I0d33c415f577b9bdc6b53bb8151bb7f564733b3d
Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
1 file changed
tree: 4baa7e2dc8bf01e0808ddf67aab03352b8a52fe7
  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. ringbuffer.c
  16. socket-handler.c
  17. tty-handler.c
  18. 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.