~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/server.txt

  • Committer: joe blow
  • Date: 2007-02-27 21:24:38 UTC
  • mto: (2293.1.5 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 2311.
  • Revision ID: joe@blow.com-20070227212438-ndpq6lsmn9ahroz5
Updated documents for grammer, spelling, and clarity.

Show diffs side-by-side

added added

removed removed

Lines of Context:
28
28
protocol as a dumb server.  This is the first stage high performance server
29
29
functionality to be delivered.
30
30
 
31
 
The current high performance server provides read only access by default for
32
 
security. To enable read-write access, run it with --allow-writes. When using
33
 
the SSH access method, bzr automatically runs with with the --allow-writes
34
 
option.
 
31
The current high performance server provides read-only access by
 
32
default for security. To enable read-write access, run it with
 
33
``--allow-writes``. When using the SSH access method, bzr
 
34
automatically runs with with the ``--allow-writes`` option.
35
35
 
36
 
It can be configured to run in three different ways:
 
36
The server can be configured to run in three different ways:
37
37
 
38
38
SSH
39
39
---
42
42
 
43
43
    BZR_REMOTE_PATH=~/bin/bzr bzr log bzr+ssh://host/path/to/branch
44
44
 
45
 
The `BZR_REMOTE_PATH` environment variable adjusts how `bzr` will be invoked on
 
45
The ``BZR_REMOTE_PATH`` environment variable adjusts how `bzr` will be invoked on
46
46
the remote system.  By default, just `bzr` will be invoked, which requires the
47
47
`bzr` executable to be on the default search path.
48
48
 
49
 
The `bzr+ssh://` URL scheme only supports absolute paths from the root of the
50
 
filesystem.  Future versions are expected to support `~` in the same way as
51
 
`sftp://` URLs.
 
49
The ``bzr+ssh://`` URL scheme only supports absolute paths from the root of the
 
50
filesystem.  Future versions are expected to support ``~`` in the same way as
 
51
``sftp://`` URLs.
52
52
 
53
53
inetd
54
54
-----
55
55
 
56
 
This example shows how to run `bzr` with a dedicated user `bzruser` for a shared
57
 
repository in `/srv/bzr/repo` which has a branch at `/srv/bzr/repo/branchname`
 
56
This example shows how to run `bzr` with a dedicated user `bzruser`
 
57
for a shared repository in ``/srv/bzr/repo`` which has a branch at
 
58
``/srv/bzr/repo/branchname``.
58
59
 
59
60
Running a Bazaar server from inetd requires an inetd.conf entry::
60
61
 
61
62
    1234  stream  tcp  nowait  bzruser  /usr/bin/bzr serve --inet --directory=/srv/bzr/repo
62
63
 
63
64
When running client commands, the URL you supply is a `bzr://` URL relative to
64
 
the `--directory` option given in inetd.conf::
 
65
the ``--directory`` option given in inetd.conf::
65
66
 
66
67
    bzr log bzr://host:1234/branchname
67
68
 
69
70
---------
70
71
 
71
72
This mode has the same path and URL behaviour as the inetd mode.  To run as a
72
 
specific, you should use `su` or login as that user.  This example runs bzr
73
 
serve on `localhost` port `1234`.
 
73
specific user, you should use ``su`` or login as that user.  This example runs ``bzr
 
74
serve`` on `localhost` port `1234`.
74
75
 
75
76
server::
76
77