aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorstefan11111 <stefan11111@shitposting.expert>2024-10-08 13:53:09 +0300
committerGitHub <noreply@github.com>2024-10-08 06:53:09 -0400
commitcb595c56d41b0c38be69a2265d820d4107b0c8a4 (patch)
tree89644b68d18d76657059cfeffd6752d165d50585 /README.md
parentsome code improvements and a new feature (#137) (diff)
downloadkirc-cb595c56d41b0c38be69a2265d820d4107b0c8a4.tar.gz
kirc-cb595c56d41b0c38be69a2265d820d4107b0c8a4.tar.bz2
kirc-cb595c56d41b0c38be69a2265d820d4107b0c8a4.tar.xz
kirc-cb595c56d41b0c38be69a2265d820d4107b0c8a4.tar.zst
kirc-cb595c56d41b0c38be69a2265d820d4107b0c8a4.zip
remove some magic numbers, clean up DCC ipv4/ipv6 global variable mess and use a union to save memory. (#139)
Co-authored-by: Emeka Nkurumeh <emekankurumeh@outlook.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 21 insertions, 3 deletions
diff --git a/README.md b/README.md
index ac238eb..3f5f7a5 100644
--- a/README.md
+++ b/README.md
@@ -15,11 +15,29 @@ Building and installing from source:
Consult `man kirc` for a full list and explanation of available arguments.
- kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname]
- [-u username] [-k password] [-a token] [-o logfile] [-e|x|v|V]
+ kirc [-s hostname] [-p port] [-c channels] [-n nickname] [-r realname] [-a auth]
+ [-u username] [-k password] [-a token] [-o logfile] [-D directory] [-4|6|d|e|x|v|V]
## DCC
- DCC transfers are always accpeted without user interaction and downloaded to the current directory.
+ DCC transfers are only accepted if the -d flag is passed to kirc.
+ If -d is passed to kirc, DCC transfers are always accpeted without user interaction
+ and downloaded to the configured directory.
+ If no directory is set with the -D option, files are downloaded to the current directory.
+
+ ## DCC SEND
+ DCC SEND is only enabled if the -d flag is passed to kirc.
+ You can send files via DCC SEND using the folowing command:
+ /dcc <target nick> <path to file> <internal ip> <external ip> <port>
+ If you are sending files to clients outside of your lan, you must
+ make sure that the chosen port is open and forwarded to
+ the sending machine's internal address.
+ Thus is usually done from your router's settings.
+ For example:
+ /dcc dcc_client /home/user/upload/file.txt 192.168.1.100 12.34.56.78 10000
+ This command would send the file located at /home/user/upload/file.txt to the nick
+ dcc_client, assuming the sending machine's local ip is 192.168.1.100, and
+ the sending machine's external ip is 12.34.56.78, and that the port 10000
+ is open and forwarded to the sending machine's local address.
## Command Aliases