1keyirc 0.1.1 - getting started
=============================

Run 1keyirc, dismiss the welcome, and type /quickstart.

    1keyirc
    /quickstart

Answer four questions: Server, Use TLS, Port, and Nickname. Enter keeps the
displayed value. TLS defaults to verified encryption; its usual port is
6697. Your Unix login supplies the initial nickname when it is valid for
IRC. Up returns to the previous question; Escape cancels the setup draft.

The final screen reviews the destination and asks what to do:

    1  Save and connect
    2  Save only
    3  Connect once
    4  Apply without saving

Quickstart defaults to 3, so Enter connects without changing your saved
startup behavior. Choose 1 if you also want these settings saved. Nothing
connects or writes a configuration file before that final choice.

After connecting, the server's welcome and MOTD appear. Join a channel:

    /join #ircnow

Once the join succeeds, ordinary typing opens the message composer. The
first typed character is retained. Enter sends the message and restores
the log; Escape cancels the draft. Incoming chat remains in bounded memory
while you compose. Long messages require explicit approval before splitting.

Moving between conversations
----------------------------

    /cl                 list channels; /channels is the full name
    /channel #ircnow     open a joined channel
    /channel 0          show the server's messages and MOTD
    /ql                 list private queries; /queries is the full name
    /pm alice           open a private conversation without sending
    /sl                 list server profiles; /servers is the full name
    /server 1           select another server profile

The short list commands end in l for list. Query and channel lists are
separate. /part leaves a channel; /close closes a retained conversation.

Guided settings
---------------

/panel asks which saved server profile to edit, then walks through its
connection, automatic startup, auto-join, authentication, history, mention,
and ignore settings. Profile 0 also owns application-wide send mode and
output format. Editing another profile does not change your chat view.

Enter keeps a shown value. A single - clears an optional field. For mention
and ignore lists, Enter keeps an existing entry or finishes an empty new
entry; - removes the shown entry. Up goes back. Escape discards unapplied
answers. The final choices are the same as Quickstart, with Save only the
default. An existing live connection is not interrupted by Save or Apply.

Passwords can come from a private plaintext file, a GPG-encrypted file, or
a hidden plaintext entry saved in the config. Setup does not read credential
files; connecting does. Answers are never added to command history. Changing
an existing server host clears its old authentication, auto-join, auto-connect,
and custom CA settings in the draft, so those can be configured for the new
destination. The final review identifies that reset.

Configuration is saved privately at $XDG_CONFIG_HOME/1keyirc/config.ini,
or $HOME/.config/1keyirc/config.ini when XDG_CONFIG_HOME is unset. --config
selects another file. Config paths and credential paths are literal.

Help stays separate from chat
-----------------------------

    /help                  show the starting points
    /help ls               list help topics
    /help quickstart        explain guided connection setup
    /help configuration     explain the config file
    /help autoauth          explain account login settings
    /help commands          explain commands and list them

Help opens a separate scrollable reader. Use Up/Down, Page Up/Page Down,
or Home/End; Escape returns to the log. Help does not enter chat history.
Networking continues while you read. In Command, Tab completes names and
Up/Down recalls accepted commands. Password commands are not retained.

Normal chat is [HH:MM:SS] <nickname> text. /set output_format full adds
server, date, and target context; /set output_format compact restores the
default. /save output keeps the choice. /set send_mode review enables a
second Enter after reviewing the log; /set send_mode direct restores direct
sending, and /save input saves that choice.

Leaving and returning
---------------------

Ctrl-C terminates. Ctrl-Z suspends; fg resumes. Ctrl-D is inert. Escape in
the log exits; Escape inside an editor, reader, or setup screen cancels or
returns. /background keeps networking active while returning to your shell.
Use 1keyirc --resume, or 1keyirc --sessions and 1keyirc --resume NUMBER when
more than one detached session exists.

Use 1keyirc --test-mode for simulated activity without network connections,
credential reads, or configuration writes. 1keyirc --manual prints the full
reference, and man 1keyirc opens the system manual after installation.

An application of ThatIAm.vip (www.thatiam.vip), designed by remfan1994.
See the included Insha-Allah License Agreement for the license terms.
