Skip to content

Commit

Permalink
cmake up + doc up
Browse files Browse the repository at this point in the history
  • Loading branch information
tehnick committed Sep 18, 2011
1 parent 9274548 commit 87b346f
Show file tree
Hide file tree
Showing 11 changed files with 393 additions and 54 deletions.
14 changes: 14 additions & 0 deletions eiskaltdcpp-cli/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,17 @@ install (FILES cli.pl DESTINATION ${BINDIR} RENAME eiskaltdcpp-cli

install (FILES config.pl DESTINATION ${CLIENT_DATA_DIR}/cli
PERMISSIONS OWNER_READ OWNER_WRITE OWNER_EXECUTE GROUP_READ GROUP_EXECUTE WORLD_READ WORLD_EXECUTE)

if (UNIX)
execute_process (
OUTPUT_FILE ${PROJECT_BINARY_DIR}/eiskaltdcpp-cli.1.gz
COMMAND "${GZIP_CMD}" -9
INPUT_FILE eiskaltdcpp-cli.1
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/)
endif (UNIX)

if (APPLE)
install (FILES ${PROJECT_BINARY_DIR}/eiskaltdcpp-cli.1.gz DESTINATION ${PROJECT_NAME_GLOBAL}.app/man/man1)
elseif (UNIX AND NOT APPLE)
install (FILES ${PROJECT_BINARY_DIR}/eiskaltdcpp-cli.1.gz DESTINATION ${SHARE_DIR}/man/man1)
endif (APPLE)
39 changes: 10 additions & 29 deletions eiskaltdcpp-cli/README
Original file line number Diff line number Diff line change
@@ -1,36 +1,17 @@
==========
eiskaltdcpp-cli is a console client for nasdc/eiskaltdcpp-deamon
eiskaltdcpp-cli is a console client for eiskaltdcpp-deamon written on perl

Daemon provides xml-rpc interface to controll themself, so console client uses it.
XML-RPC is a simple http-based protocol, consist of set of commands on server side, wich requested by client.
The set of commands on sever side is unique to server.

XML-RPC is a simple http-based protocol, consist of set of commands on server side, wich requested by client. The set of commands on sever side is unique to server.

Dependencies:
perl >= 5.10
RPC::XML perl module
Term::ShellUI perl module
perl >= 5.10
RPC::XML perl module
Term::ShellUI perl module

Usage:
After client starts, the command prompt appears. Command prompt has a search capability, history, completition
(FS, commands). To overview command list execute `help`, or `help command`, where command is a desired command from the list.
Also, there configuration file is, and it is a good idea to write down some configuration to it, such as command prompt,
server address, and so.

========== Russian, UTF-8 ===========
eiskaltdcpp-cli - консольный клиент для nasdc/eiskaltdcpp-deamon, написанный на perl
Демон предоставляет xml-rpc интерфейс для управления собой, и консольный клиент управляет демоном посредство xml-rpc.
XML-RPC представляет собой http-based протокол, состоящий из команд от клиента к северу и ответов от сервера к клиенту.
Набор комманд уникален в рамках каждого сервера, в том числе и в нашем случае.
Таким образом, на стороне сервера имеется некий список команд, выдающих результаты, и клиент, путем запросов к серверу,
получает результаты выполнения этих команд.

Требования:
perl > 5.10
модуль perl RPC::XML
модуль perl Term::ShellUI
After client starts, the command prompt appears. Command prompt has a search capability, history, completition (FS, commands).

Работа с консольным клиентом:
После запуска клиента появится приглашение командной строки, которая имеет поиск, историю, автодополнение (пути ФС, команды и тд).
Со списком команд можно ознакомится выполнив команду help, или help command, где command - интересущая команда.
Так же существует файл конфигурации консольного клиента, куда имеет смысл вписать основную конфигурацию клиента, такую как
вид приглашения командной строки, адрес xml-rpc сервера, и тд.
To overview command list execute `help`, or `help command`, where command is a desired command from the list.

Also, there configuration file is, and it is a good idea to write down some configuration to it, such as command prompt, server address, and so.
18 changes: 18 additions & 0 deletions eiskaltdcpp-cli/README_ru
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
eiskaltdcpp-cli - консольный клиент для eiskaltdcpp-deamon, написанный на perl

Демон предоставляет xml-rpc интерфейс для управления собой, и консольный клиент управляет демоном посредством xml-rpc.

XML-RPC представляет собой http-based протокол, состоящий из команд от клиента к северу и ответов от сервера к клиенту. Набор комманд уникален в рамках каждого сервера. Таким образом, на стороне сервера имеется некий список команд, выдающих результаты, и клиент, путем запросов к серверу, получает результаты выполнения этих команд.

Зависимости:
perl >= 5.10
модуль perl RPC::XML
модуль perl Term::ShellUI

Работа с консольным клиентом:

После запуска клиента появится приглашение командной строки, которая имеет поиск, историю, автодополнение (пути ФС, команды и тд).

Со списком команд можно ознакомится выполнив команду help, или help command, где command - интересущая команда.

Так же существует файл конфигурации консольного клиента, куда имеет смысл вписать основные настройки, такие как вид приглашения командной строки, адрес xml-rpc сервера, и тд.
45 changes: 45 additions & 0 deletions eiskaltdcpp-cli/eiskaltdcpp-cli.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
.TH "eiskaltdcpp-cli" 1 "18 Sep 2011"
.SH "NAME"
EiskaltDC++_CLI \- simple command line interface for EiskaltDC++ Daemon written on perl
.SH "SYNOPSIS"
.PP
.B eiskaltdcpp-cli
.br
.B eiskaltdcpp-cli
<Key>
.SH "DESCRIPTION"
.PP
\fBEiskaltDC++\fP is a cross-platform program that uses the Direct Connect and ADC protocol. It is compatible with other DC clients, such as the original DC from Neomodus, DC++ and derivatives. EiskaltDC++ also interoperates with all common DC hub software.
.PP
To use this program you need first install few perl modules:
.br
sudo cpan Term::ShellUI
.br
sudo cpan RPC::XML
.SH "COMMAND LINE OPTIONS"
.RB "A summary of options is included below."
.TP
.BR "\-h, \-\-help"
Display help and exit
.TP
.BR "\-v, \-\-version"
Show version information and exit
.SH "FILES"
.TP
.B "~/.config/eiskaltdc++/" or "$XDG_CONFIG_HOME/eiskaltdc++/"
Directory with user configuration files and logs
.TP
.B "/usr/local/share/eiskaltdcpp/cli/" or "/usr/share/eiskaltdcpp/cli/"
Directory with default configuration file
.SH "DOCUMENTATION"
.TP
Actual README file you can always find here: \fBhttps://raw.github.com/negativ/eiskaltdcpp/master/eiskaltdcpp-cli/README\fR
.SH AUTHOR
This program was written by Dmitry Kolosov <[email protected]> and others (see file AUTHORS).
.br
EiskaltDC++ homepage: \fBhttp:https://code.google.com/p/eiskaltdc/\fR
.SH "BUG REPORTS"
If you find a bug in EiskaltDC++ please report it here:
.B http:https://code.google.com/p/eiskaltdc/issues/list
.PP
This manual page was written by Boris Pek <[email protected]> for the Debian project (and may be used by others).
109 changes: 109 additions & 0 deletions eiskaltdcpp-cli/man.eiskaltdcpp-cli.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of eiskaltdcpp-cli</TITLE>
</HEAD><BODY>
<H1>eiskaltdcpp-cli</H1>
Section: User Commands (1)<BR>Updated: 18 Sep 2011<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

EiskaltDC++_CLI - simple command line interface for EiskaltDC++ Daemon written on perl
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>

<P>

<B>eiskaltdcpp-cli</B>

<BR>

<B>eiskaltdcpp-cli</B>

&lt;Key&gt;
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>

<P>

<B>EiskaltDC++</B> is a cross-platform program that uses the Direct Connect and ADC protocol. It is compatible with other DC clients, such as the original DC from Neomodus, DC++ and derivatives. EiskaltDC++ also interoperates with all common DC hub software.
<P>

To use this program you need first install few perl modules:
<BR>

sudo cpan Term::ShellUI
<BR>

sudo cpan RPC::XML
<A NAME="lbAE">&nbsp;</A>
<H2>COMMAND LINE OPTIONS</H2>

A summary of options is included below.

<DL COMPACT>
<DT><B>-h, --help</B>

<DD>
Display help and exit
<DT><B>-v, --version</B>

<DD>
Show version information and exit
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>FILES</H2>

<DL COMPACT>
<DT><B>~/.config/eiskaltdc++/ or $XDG_CONFIG_HOME/eiskaltdc++/</B>

<DD>
Directory with user configuration files and logs
<DT><B>/usr/local/share/eiskaltdcpp/cli/ or /usr/share/eiskaltdcpp/cli/</B>

<DD>
Directory with default configuration file
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>DOCUMENTATION</H2>

<DL COMPACT>
<DT>Actual README file you can always find here: <B><A HREF="https://raw.github.com/negativ/eiskaltdcpp/master/eiskaltdcpp-cli/README">https://raw.github.com/negativ/eiskaltdcpp/master/eiskaltdcpp-cli/README</A></B><DD>
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>AUTHOR</H2>

This program was written by Dmitry Kolosov &lt;<A HREF="mailto:[email protected]">[email protected]</A>&gt; and others (see file AUTHORS).
<BR>

EiskaltDC++ homepage: <B><A HREF="http:https://code.google.com/p/eiskaltdc/">http:https://code.google.com/p/eiskaltdc/</A></B>
<A NAME="lbAI">&nbsp;</A>
<H2>BUG REPORTS</H2>

If you find a bug in EiskaltDC++ please report it here:
<B><A HREF="http:https://code.google.com/p/eiskaltdc/issues/list">http:https://code.google.com/p/eiskaltdc/issues/list</A></B>

<P>

This manual page was written by Boris Pek &lt;<A HREF="mailto:[email protected]">[email protected]</A>&gt; for the Debian project (and may be used by others).
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT><A HREF="#lbAE">COMMAND LINE OPTIONS</A><DD>
<DT><A HREF="#lbAF">FILES</A><DD>
<DT><A HREF="#lbAG">DOCUMENTATION</A><DD>
<DT><A HREF="#lbAH">AUTHOR</A><DD>
<DT><A HREF="#lbAI">BUG REPORTS</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 18:59:36 GMT, September 18, 2011
</BODY>
</HTML>
67 changes: 66 additions & 1 deletion eiskaltdcpp-gtk/eiskaltdcpp-gtk.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "eiskaltdcpp-gtk" 1 "02 Oct 2010"
.TH "eiskaltdcpp-gtk" 1 "18 Sep 2011"
.SH "NAME"
EiskaltDC++_Gtk \- GUI based on Gtk (based on FreeDC++ and LinuxDC++)
.SH "SYNOPSIS"
Expand All @@ -19,6 +19,61 @@ display help and exit
.TP
.BR "\-v, \-\-version"
output version information and exit
.SH "KEYBOARD SHORTCUTS"
.RB "These are default keyboard shortcuts. You can change them in any text editor. For example:"
.br
sudo nano /usr/share/eiskaltdcpp/gtk/ui/mainwindow.ui
.TP
.B "Ctrl+O"
Open options window
.TP
.B "Ctrl+L"
Open own filelist
.TP
.B "Ctrl+E"
Refresh share
.TP
.B "Ctrl+R"
Reconnect to hub
.TP
.B "Ctrl+N"
Quick connect
.TP
.B "Ctrl+H"
Favourite hubs
.TP
.B "Ctrl+P"
Public hubs
.TP
.B "Ctrl+U"
Favourite users
.TP
.B "Ctrl+D"
Show/hide downloads queue widget
.TP
.B "Ctrl+S"
Open search widget
.TP
.B "Ctrl+F"
Show/hide find or filter frame
.TP
.B "Ctrl+A"
Select all
.TP
.B "Ctrl+W"
Close current widget
.TP
.B "Ctrl+PageUp"
Switch to the previous widget. Available only if widget panel is used, not working in mode of sidebar.
.TP
.B "Ctrl+PageDown"
Switch to the next widget. Available only if widget panel is used, not working in mode of sidebar.
.TP
.B "Up"
Switch to the previous string from history of sent messages in chat for current session. Available only when input frame is focused on.
.TP
.B "Down"
Switch to the next string from history of sent messages in chat for current session. Available only when input frame is focused on.
.SH "CHAT COMMANDS"
/away <message> \- Away mode message on/off
.br
Expand Down Expand Up @@ -74,6 +129,16 @@ output version information and exit
.br
/A \- Alias A executing
.br
/ip on/off \- Ipfilter on/off
.br
/ip list \- Show ipfilter rules list
.br
/ip up/down \- Move rule up/down
.br
/ip purge 192.168.1.0/23;192.168.6.0/24 \- Remove rules from list
.br
/ip 192.168.1.0/23::in;!192.168.6.0/24::both \- Add rule 192.168.1.0/23 where direction incoming and action is allow and 192.168.6.0/24 where direction is incoming or outcoming and action is drop
.br
/ws <option> [value] \- edit config (~/.config/eiskaltdc++/EiskaltDC++_Gtk.xml), also you can edit it manually
For example:
/ws sound-command aplay (specify program for sound playing)
Expand Down
Loading

0 comments on commit 87b346f

Please sign in to comment.