diff options
| author | 2024-08-05 06:21:55 +0200 | |
|---|---|---|
| committer | 2024-08-05 06:21:55 +0200 | |
| commit | d2b3a7d7081f9c296f3df28642322f1280f36c92 (patch) | |
| tree | 77a4f51f5c19a4d052004a774b2dc4d82c4f5af8 | |
| parent | Updated RELEASE_NOTES. (diff) | |
| download | snac2-d2b3a7d7081f9c296f3df28642322f1280f36c92.tar.gz snac2-d2b3a7d7081f9c296f3df28642322f1280f36c92.tar.xz snac2-d2b3a7d7081f9c296f3df28642322f1280f36c92.zip | |
Updated documentation.
| -rw-r--r-- | doc/snac.8 | 14 |
1 files changed, 7 insertions, 7 deletions
| @@ -58,6 +58,8 @@ specially the host name it will run under, the local network address | |||
| 58 | and port | 58 | and port |
| 59 | .Nm | 59 | .Nm |
| 60 | will listen to, the optional path prefix and possibly other things. | 60 | will listen to, the optional path prefix and possibly other things. |
| 61 | Since version 2.57, if the 'network address' starts with /, it's | ||
| 62 | assumed to be a UNIX-like socket. | ||
| 61 | .Pp | 63 | .Pp |
| 62 | You can launch the | 64 | You can launch the |
| 63 | .Nm | 65 | .Nm |
| @@ -66,9 +68,6 @@ process by running | |||
| 66 | snac httpd $HOME/snac-data | 68 | snac httpd $HOME/snac-data |
| 67 | .Ed | 69 | .Ed |
| 68 | .Pp | 70 | .Pp |
| 69 | Use a web browser to connect to the specified address and port. You | ||
| 70 | should see a greeting page. | ||
| 71 | .Pp | ||
| 72 | Log messages are sent to the standard error stream. By default, only | 71 | Log messages are sent to the standard error stream. By default, only |
| 73 | relevant information is written there. You can increase the debugging | 72 | relevant information is written there. You can increase the debugging |
| 74 | level by editing the 'dbglevel' field in the | 73 | level by editing the 'dbglevel' field in the |
| @@ -76,7 +75,7 @@ level by editing the 'dbglevel' field in the | |||
| 76 | file or by setting a numeric value between 0 and 3 to the DEBUG | 75 | file or by setting a numeric value between 0 and 3 to the DEBUG |
| 77 | environment variable, see below. | 76 | environment variable, see below. |
| 78 | .Pp | 77 | .Pp |
| 79 | If you operate a Linux systemd-enabled system, OpenBSD or FreeBSD, there are | 78 | If you operate a Linux systemd-enabled system, OpenBSD, FreeBSD or NetBSD, there are |
| 80 | startup scripts and configuration data in the | 79 | startup scripts and configuration data in the |
| 81 | .Pa examples | 80 | .Pa examples |
| 82 | directory. | 81 | directory. |
| @@ -128,9 +127,10 @@ The host name. | |||
| 128 | .It Ic prefix | 127 | .It Ic prefix |
| 129 | The URL path prefix. | 128 | The URL path prefix. |
| 130 | .It Ic address | 129 | .It Ic address |
| 131 | The listen network address. | 130 | The listen network address. If it starts with /, it's assumed to be |
| 131 | a UNIX-like socket instead. | ||
| 132 | .It Ic port | 132 | .It Ic port |
| 133 | The listen network port. | 133 | The listen network port (unused if address is a UNIX socket). |
| 134 | .It Ic dbglevel | 134 | .It Ic dbglevel |
| 135 | The debug level. An integer value, being 0 the less verbose (the default). | 135 | The debug level. An integer value, being 0 the less verbose (the default). |
| 136 | .It Ic layout | 136 | .It Ic layout |
| @@ -551,7 +551,7 @@ fastcgi_pass localhost:8001; | |||
| 551 | .Pp | 551 | .Pp |
| 552 | The only thing to change on | 552 | The only thing to change on |
| 553 | .Nm | 553 | .Nm |
| 554 | size is to the set 'fastcgi' value to true in | 554 | is to the set 'fastcgi' value to true in |
| 555 | .Pa server.json . | 555 | .Pa server.json . |
| 556 | .Pp | 556 | .Pp |
| 557 | Further, using the FastCGI interface allows a much simpler configuration | 557 | Further, using the FastCGI interface allows a much simpler configuration |