aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorziggys <ziggys@autistici.org>2018-07-15 21:02:21 -0400
committerziggys <ziggys@autistici.org>2018-07-15 21:02:21 -0400
commit614d4766791a97ad595d2af710a259ebd1873960 (patch)
tree91ae1745eca2c1ee1bf1c4999108ec5053f669fc
parentb440efc4bc308a703d140acdc9000f4f81ed15af (diff)
downloadgsocial-cli-614d4766791a97ad595d2af710a259ebd1873960.tar
gsocial-cli-614d4766791a97ad595d2af710a259ebd1873960.zip
Begin documentation
-rw-r--r--.README.txt.swobin0 -> 12288 bytes
-rw-r--r--README.txt100
-rw-r--r--themes/default.theme20
-rw-r--r--themes/greyscale.theme20
4 files changed, 140 insertions, 0 deletions
diff --git a/.README.txt.swo b/.README.txt.swo
new file mode 100644
index 0000000..9eb34e8
--- /dev/null
+++ b/.README.txt.swo
Binary files differ
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..3f1c9a5
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,100 @@
+Gnu-social Command Line Interface (gsocial-cli)
+-----------------------------------------------
+
+
+About
+-----
+gsocial-cli is an actually simple, minimalistic and full featured command-line
+client for gnu-social that iteracts with 'ostatus' api using curl and core
+'*nix' utilities.
+
+
+Install systemwide
+------------------
+
+Manually
+--------
+Clone repository and copy the script into proper location (e.g /usr/bin)
+
+
+ ~$ cd /tmp
+
+ /tmp$ git clone https://git.p4g.club/git/gsocial-cli.git gsocial-cli
+
+ /tmp$ sudo cp gsocial-cli/gsocial-cli.sh /usr/bin/gsocial-cli
+
+ /tmp$ sudo chmod +x /usr/bin/gsocial-cli && cd
+
+
+Using install.sh
+----------------
+Alternatively you can clone and run install.sh script inside
+scripts directory within repository.
+
+
+ ~$ cd /tmp
+
+ /tmp$ git clone https://git.p4g.club/git/gsocial-cli.git gsocial-cli
+
+ /tmp$ cd gsocial-cli/scripts && ./install.sh
+
+
+Usage
+-----
+Once installed, run:
+
+
+ ~$ gsocial-cli
+
+
+----------------
+gsocial-cli version 'x.y.z'
+ by ziggys
+ License: The Drunken Beer License v 1.1
+
+gsocial-cli is an actually simple, minimalistic and full-featured
+ command-line client for gnu-social that iteracts with 'ostatus' api
+ usign curl and core '*nix' utilitiies.
+
+Usage: gsocial-cli -c <account>
+ or: gsocial-cli -a <account> [option] <args>
+ gsocial-cli -a <account> [-t|-T|-m] <number>
+ or: gsocial-cli -a <account> [-r|-f|-d|-q|-R] <status_id>
+ or: gsocial-cli -a <account> [-p|-s]
+ or: gsocial-cli -h
+
+Options
+ -c <account> Create a configuration file for 'account'
+ -t <N> Retrieve last 'N' statuses from 'home timeline'
+ -T <N> Retrieve last 'N' statuses from 'public timeline'
+ -m <N> Retrieve last 'N' 'mentions' and 'interactions'
+ -s SENT Retrieve your own 20 most recent statuses
+ -r <ID> Repeat status with 'id' code number
+ -d <ID> Delete status with 'id' code number
+ -f <ID> Favorite status with 'id' code number
+ -q <ID> Repeat status with 'id' code number, adding your own text
+ -R <ID> Reply status with 'id' code number
+ -p POST Post a status message. Option don't uses arguments
+ -h HELP Print this help and exit
+
+Set general configuration parametters
+Usage: ${gsocial-cli} set option=value
+
+General Settings
+ d_account Sets default account for avoiding '-a account' option
+ g_theme Sets global theme for colorized output
+ d_editor Sets default editor
+ history_keep Sets number of maximun lines to keep in history
+ ... More settings to come
+
+For more details about this script go to
+Official Repository: https://git.p4g.club/git/gsocial-cli
+Mirror Repository: https://gitgud.io/ziggys/gsocial-cli
+
+----------------
+
+
+User-guide (in progress)
+------------------------
+
+
diff --git a/themes/default.theme b/themes/default.theme
new file mode 100644
index 0000000..ca6b0e5
--- /dev/null
+++ b/themes/default.theme
@@ -0,0 +1,20 @@
+#
+# gsocial-cli -- default.theme
+#
+# Colors uses 'ANSI escape codes'
+#
+# Black 0;30m - DarkGrey 1;30m
+# Red 0;31m - LightRed 1;31m
+# Green 0;32m - LightGreen 1;32m
+# Brown/Orange 0;33m - Yellow 1;33m
+# Blue 0;34m - LightBlue 1;34m
+# Purple 0;35m - LightPurple 1;35m
+# Cyan 0;36m - LightCyan 1;36m
+# LightGray 0;37m - White 1;37m
+#
+sname_c=1;32m
+uname_c=0;37m
+sid_c=0;33m
+text_c=0;37m
+meta_c=0;36m
+esq_seq=0m
diff --git a/themes/greyscale.theme b/themes/greyscale.theme
new file mode 100644
index 0000000..8e276bd
--- /dev/null
+++ b/themes/greyscale.theme
@@ -0,0 +1,20 @@
+#
+# gsocial-cli -- default.theme
+#
+# Colors uses 'ANSI escape codes'
+#
+# Black 0;30m - DarkGrey 1;30m
+# Red 0;31m - LightRed 1;31m
+# Green 0;32m - LightGreen 1;32m
+# Brown/Orange 0;33m - Yellow 1;33m
+# Blue 0;34m - LightBlue 1;34m
+# Purple 0;35m - LightPurple 1;35m
+# Cyan 0;36m - LightCyan 1;36m
+# LightGray 0;37m - White 1;37m
+#
+sname_c=1;30m
+uname_c=0;37m
+sid_c=1;30m
+text_c=0;37m
+meta_c=1;37m
+esq_seq=0m