Fossil SCM
Remove references to the obsolete "ping" feature from the chat documentation.
Commit
017ec310c26442a4dbd324cb155d2659f6cde595128c0f8046a989427776a532
Parent
f572b62f22466af…
1 file changed
-37
-37
| --- www/chat.md | ||
| +++ www/chat.md | ||
| @@ -75,41 +75,10 @@ | ||
| 75 | 75 | [Markdown](/md_rules) understand hyperlinks) then that text |
| 76 | 76 | is tagged. |
| 77 | 77 | |
| 78 | 78 | Apart from adding hyperlink anchor tags to bits of text that look |
| 79 | 79 | like hyperlinks, no changes are made to the input text. |
| 80 | - | |
| 81 | -## Aural Alerts | |
| 82 | - | |
| 83 | -If you have a local clone and checkout for a remote Fossil repository | |
| 84 | -and that remote repository supports chat, | |
| 85 | -then you can bring up a chat window for that remote repository | |
| 86 | -that will beep whenever new content arrives. This must be done from a | |
| 87 | -terminal window. | |
| 88 | -Change directories to a working checkout of the local clone and type: | |
| 89 | - | |
| 90 | -> fossil chat | |
| 91 | - | |
| 92 | -This command will bring up a chat window in your default web-browser | |
| 93 | -(similar to the way the "[fossil ui](/help?cmd=ui)" does). The | |
| 94 | -chat will be for the remote repository, the repository whose URL shows | |
| 95 | -when you type the "[fossil remote](/help?cmd=remote)" command. In | |
| 96 | -addition to bringing up the chat window, this command will also | |
| 97 | -send a single "bel" character (U+0007) to standard error of the terminal | |
| 98 | -whenever new messages arrive in the chat window. On most systems, | |
| 99 | -the terminal windows will emit an "beep" whenever they receive the U+0007 | |
| 100 | -character. This works out-of-the-box for Mac and Windows, but on some | |
| 101 | -flavors of Linux, you might need to enable terminal beeps in your system | |
| 102 | -preferences. | |
| 103 | - | |
| 104 | -In theory, it should be possible to get a web-browser to make an alert | |
| 105 | -sound whenever new content arrives in the chat window. However, the | |
| 106 | -Fossil developers have been unable to figure out how to do that. | |
| 107 | -Web-browsers make it very difficult to play sounds that are | |
| 108 | -not the direct result of a user-click, probably to prevent | |
| 109 | -advertisements from pestering users with a cacophony of alerts. | |
| 110 | - | |
| 111 | 80 | |
| 112 | 81 | ## Implementation Details |
| 113 | 82 | |
| 114 | 83 | *You do not need to understand how Fossil chat works in order to use it. |
| 115 | 84 | But many developers prefer to know how their tools work. |
| @@ -133,16 +102,10 @@ | ||
| 133 | 102 | Sends a new chat message to the server. |
| 134 | 103 | |
| 135 | 104 | * **/chat-delete** → |
| 136 | 105 | Delete a chat message. |
| 137 | 106 | |
| 138 | - * **/chat-ping** → | |
| 139 | - An HTTP request to this page on the loopback IP address causes | |
| 140 | - a single U+0007 "bel" character to be sent to standard error of | |
| 141 | - the controlling terminal. This is used to implement | |
| 142 | - aural alerts with the "[fossil chat](/help?cmd=chat)" command. | |
| 143 | - | |
| 144 | 107 | Fossil chat uses the venerable "hanging GET" or |
| 145 | 108 | "[long polling](wikipedia:/wiki/Push_technology#Long_polling)" |
| 146 | 109 | technique to recieve asynchronous notification of new messages. |
| 147 | 110 | This is done because long polling works well with CGI and SCGI, |
| 148 | 111 | which are the usual mechanisms for setting up a Fossil server. |
| 149 | 112 |
| --- www/chat.md | |
| +++ www/chat.md | |
| @@ -75,41 +75,10 @@ | |
| 75 | [Markdown](/md_rules) understand hyperlinks) then that text |
| 76 | is tagged. |
| 77 | |
| 78 | Apart from adding hyperlink anchor tags to bits of text that look |
| 79 | like hyperlinks, no changes are made to the input text. |
| 80 | |
| 81 | ## Aural Alerts |
| 82 | |
| 83 | If you have a local clone and checkout for a remote Fossil repository |
| 84 | and that remote repository supports chat, |
| 85 | then you can bring up a chat window for that remote repository |
| 86 | that will beep whenever new content arrives. This must be done from a |
| 87 | terminal window. |
| 88 | Change directories to a working checkout of the local clone and type: |
| 89 | |
| 90 | > fossil chat |
| 91 | |
| 92 | This command will bring up a chat window in your default web-browser |
| 93 | (similar to the way the "[fossil ui](/help?cmd=ui)" does). The |
| 94 | chat will be for the remote repository, the repository whose URL shows |
| 95 | when you type the "[fossil remote](/help?cmd=remote)" command. In |
| 96 | addition to bringing up the chat window, this command will also |
| 97 | send a single "bel" character (U+0007) to standard error of the terminal |
| 98 | whenever new messages arrive in the chat window. On most systems, |
| 99 | the terminal windows will emit an "beep" whenever they receive the U+0007 |
| 100 | character. This works out-of-the-box for Mac and Windows, but on some |
| 101 | flavors of Linux, you might need to enable terminal beeps in your system |
| 102 | preferences. |
| 103 | |
| 104 | In theory, it should be possible to get a web-browser to make an alert |
| 105 | sound whenever new content arrives in the chat window. However, the |
| 106 | Fossil developers have been unable to figure out how to do that. |
| 107 | Web-browsers make it very difficult to play sounds that are |
| 108 | not the direct result of a user-click, probably to prevent |
| 109 | advertisements from pestering users with a cacophony of alerts. |
| 110 | |
| 111 | |
| 112 | ## Implementation Details |
| 113 | |
| 114 | *You do not need to understand how Fossil chat works in order to use it. |
| 115 | But many developers prefer to know how their tools work. |
| @@ -133,16 +102,10 @@ | |
| 133 | Sends a new chat message to the server. |
| 134 | |
| 135 | * **/chat-delete** → |
| 136 | Delete a chat message. |
| 137 | |
| 138 | * **/chat-ping** → |
| 139 | An HTTP request to this page on the loopback IP address causes |
| 140 | a single U+0007 "bel" character to be sent to standard error of |
| 141 | the controlling terminal. This is used to implement |
| 142 | aural alerts with the "[fossil chat](/help?cmd=chat)" command. |
| 143 | |
| 144 | Fossil chat uses the venerable "hanging GET" or |
| 145 | "[long polling](wikipedia:/wiki/Push_technology#Long_polling)" |
| 146 | technique to recieve asynchronous notification of new messages. |
| 147 | This is done because long polling works well with CGI and SCGI, |
| 148 | which are the usual mechanisms for setting up a Fossil server. |
| 149 |
| --- www/chat.md | |
| +++ www/chat.md | |
| @@ -75,41 +75,10 @@ | |
| 75 | [Markdown](/md_rules) understand hyperlinks) then that text |
| 76 | is tagged. |
| 77 | |
| 78 | Apart from adding hyperlink anchor tags to bits of text that look |
| 79 | like hyperlinks, no changes are made to the input text. |
| 80 | |
| 81 | ## Implementation Details |
| 82 | |
| 83 | *You do not need to understand how Fossil chat works in order to use it. |
| 84 | But many developers prefer to know how their tools work. |
| @@ -133,16 +102,10 @@ | |
| 102 | Sends a new chat message to the server. |
| 103 | |
| 104 | * **/chat-delete** → |
| 105 | Delete a chat message. |
| 106 | |
| 107 | Fossil chat uses the venerable "hanging GET" or |
| 108 | "[long polling](wikipedia:/wiki/Push_technology#Long_polling)" |
| 109 | technique to recieve asynchronous notification of new messages. |
| 110 | This is done because long polling works well with CGI and SCGI, |
| 111 | which are the usual mechanisms for setting up a Fossil server. |
| 112 |