contrib/bochs/serial-console.1

   1 .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SERIAL-CONSOLE 1"
 132 .TH SERIAL-CONSOLE 1 "2004-03-10" "perl v5.8.0" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 serial\-console
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 serial-console [options]
 138 .PP
 139 Options:
 140 .PP
 141 .Vb 5
 142 \&    -h,--help         Display brief help message
 143 \&    -v,--verbose      Increase verbosity
 144 \&    -q,--quiet        Decrease verbosity
 145 \&    -l,--log FILE     Log output to file
 146 \&    -r,--rcfile FILE  Modify specified bochsrc file
 147 .Ve
 148 .SH "DESCRIPTION"
 149 .IX Header "DESCRIPTION"
 150 \&\f(CW\*(C`serial\-console\*(C'\fR provides a virtual serial console for use with
 151 Bochs.  Running \f(CW\*(C`serial\-console\*(C'\fR creates a pseudo\-tty.  The master
 152 side of this pty is made available to the user for interaction; the
 153 slave device is written to the Bochs configuration file
 154 (\f(CW\*(C`bochsrc.txt\*(C'\fR) for use by a subsequent Bochs session.
 155 .SH "EXAMPLES"
 156 .IX Header "EXAMPLES"
 157 .ie n .IP """serial\-console""" 4
 158 .el .IP "\f(CWserial\-console\fR" 4
 159 .IX Item "serial-console"
 160 Create a virtual serial console for Bochs, modify \f(CW\*(C`bochsrc.txt\*(C'\fR
 161 appropriately.
 162 .ie n .IP """serial\-console \-r ../.bochsrc \-l serial.log""" 4
 163 .el .IP "\f(CWserial\-console \-r ../.bochsrc \-l serial.log\fR" 4
 164 .IX Item "serial-console -r ../.bochsrc -l serial.log"
 165 Create a virtual serial console for Bochs, modify \f(CW\*(C`../.bochsrc\*(C'\fR
 166 appropriately, log output to \f(CW\*(C`serial.log\*(C'\fR.
 167 .SH "INVOCATION"
 168 .IX Header "INVOCATION"
 169 Before starting Bochs, run \f(CW\*(C`serial\-console\*(C'\fR in a different session
 170 (e.g. a different xterm window).  When you subsequently start Bochs,
 171 anything that the emulated machine writes to its serial port will
 172 appear in the window running \f(CW\*(C`serial\-console\*(C'\fR, and anything typed in
 173 the \f(CW\*(C`serial\-console\*(C'\fR window will arrive on the emulated machine's
 174 serial port.
 175 .PP
 176 You do \fBnot\fR need to rerun \f(CW\*(C`serial\-console\*(C'\fR afresh for each Bochs
 177 session.
 178 .SH "OPTIONS"
 179 .IX Header "OPTIONS"
 180 .IP "\fB\-l,\-\-log \s-1FILE\s0\fR" 4
 181 .IX Item "-l,--log FILE"
 182 Log all output (i.e. everything that is printed in the
 183 \&\f(CW\*(C`serial\-console\*(C'\fR window) to the specified file.
 184 .IP "\fB\-r,\-\-rcfile \s-1FILE\s0\fR" 4
 185 .IX Item "-r,--rcfile FILE"
 186 Modify the specified bochsrc file.  The file will be updated to
 187 contain the path to the slave side of the psuedo tty that we create.
 188 The original file will be restored when \f(CW\*(C`serial\-console\*(C'\fR exits.  The
 189 default is to modify the file \f(CW\*(C`bochsrc.txt\*(C'\fR in the current directory.
 190 .Sp
 191 To avoid modifying any bochsrc file, use \f(CW\*(C`\-\-norcfile\*(C'\fR.