summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYorhel <git@yorhel.nl>2017-09-06 20:08:11 +0200
committerYorhel <git@yorhel.nl>2017-09-06 20:08:13 +0200
commitccb5f8c7a3f2800331710ffc885226696c632fd7 (patch)
tree45a9c3347884f81cfe6916bea7c6a615fc6a35cc
parent3f35714e6b14b610fe588079388b930aba900c5d (diff)
doc: Create separate section for UI flags
Hopefully covers all of them. A separate section seemed like a better idea then putting this all under "Getting started".
-rw-r--r--doc/ncdc.pod.in89
1 files changed, 67 insertions, 22 deletions
diff --git a/doc/ncdc.pod.in b/doc/ncdc.pod.in
index 4f4b049..b831020 100644
--- a/doc/ncdc.pod.in
+++ b/doc/ncdc.pod.in
@@ -63,28 +63,6 @@ hit Alt+u. To browse someone's file list, use C</browse> or hit the 'b' key in
the user list. And to monitor your upload and download connections, use
C</connections> or hit Alt+n.
-You may see one-letter flags to the left of file names in search results and
-file list tabs. Their meaning is as follows :
-
-=over
-
-=item H
-
-The file had been added to the file list, but has not been hashed yet and thus
-is not visible to others. This flag can appear only when browsing your own list.
-
-=item S
-
-The file is already in your share. If C<download_shared> is set to C<false>,
-trying to download it will result only in an informational message. This flag
-never appears when browsing your own file list.
-
-=item Q
-
-The file is currently in your download queue. Trying to download it will result
-only in an informational message.
-
-=back
=head1 OPTIONS
@@ -190,6 +168,73 @@ C</help keys> command, and is reproduced below.
@keys@
+=head1 WEIRD UI FLAGS
+
+Some listings have a flags display, and their meaning may not be immediately obvious.
+
+=head2 File status
+
+You may see one-letter flags to the left of file names in search results and
+file list tabs. Their meaning is as follows:
+
+=over
+
+=item H
+
+The file had been added to the file list, but has not been hashed yet and thus
+is not visible to others. This flag can appear only when browsing your own list.
+
+=item S
+
+The file is already in your share. If C<download_shared> is set to C<false>,
+trying to download it will result only in an informational message. This flag
+never appears when browsing your own file list.
+
+=item Q
+
+The file is currently in your download queue. Trying to download it will result
+only in an informational message.
+
+=back
+
+=head2 Connection flags
+
+On the connection list window, there are two flags:
+
+=over
+
+=item S
+
+Connection state, can be either B<C>onnecting, B<H>andshake, B<I>dle,
+B<D>ownloading, B<U>ploading or B<-> for disconnected.
+
+=item t
+
+This means that the connection is encrypted with TLS.
+
+=back
+
+=head2 User flags
+
+The user list has some flags too:
+
+=over
+
+=item o
+
+Set if the user is an operator in the hub.
+
+=item p
+
+When the user is passive. If this flag is not set, the user is active.
+
+=item t
+
+Set if connections with this user will be encrypted with TLS.
+
+=back
+
+
=head1 ENVIRONMENT
$NCDC_DIR is used to determine the session dir, it is only honoured if I<-c> is