about summary refs log tree commit diff stats
path: root/README
blob: 20bfeb58fae342e588b6cd323d9b00b0c22101ad (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
                               ━━━━━━━━━
                                 PYXIS

                                Andinus
                               ━━━━━━━━━


Table of Contents
─────────────────

1 Documentation
.. 1.1 Commands
.. 1.2 Configuration


Pyxis is a simple twtxt client.

[twtxt] is a decentralised, minimalist microblogging service for
hackers.

• Website: [https://andinus.nand.sh/pyxis]
• Source: [https://git.tilde.institute/andinus/pyxis]
• Mirror: [https://github.com/andinus/pyxis]


[twtxt] https://github.com/buckket/twtxt


1 Documentation
═══════════════

  Pyxis can only follow feeds currently. I'm writing this for fun, more
  features will be added if I use it.

  The feeds are saved in `$XDG_DATA_HOME/pyxis', if it's not defined
  then `$HOME/.local/share/pyxis' is used. Feeds are configured in
  `$XDG_CONFIG_HOME/pyxis.pl' or `$HOME/.config/pyxis.pl'.


1.1 Commands
────────────

1.1.1 fetch
╌╌╌╌╌╌╌╌╌╌╌

  fetch will fetch all the latest feeds.


1.1.2 timeline
╌╌╌╌╌╌╌╌╌╌╌╌╌╌

  timeline will print your timeline from all the feeds. You can also
  pass an optional argument to load a single feed.

  For example, `pyxis timeline user' will load the feed `user'. You can
  pass multiple feeds like `pyxis timeline f1 f2', it'll load both `f1'
  & `f2'.


1.2 Configuration
─────────────────

  There is an example config file under `share/config.pl', move it
  config directory & rename it to `pyxis.pl'.

  *Warning*: Pyxis will evaluate the configuration file, which means an
  attacker can use it to run malicious code.

  *Note*: They could always add malicious code to `.profile' & do harm.
  Just thought I should put the warning.

  ┌────
  │ #!/usr/bin/perl
  │
  │ use strict;
  │ use warnings;
  │
  │ my %feeds = (
  │     example => "https://example.com/twtxt.txt",
  │ );
  │
  │ sub get_feeds { return %feeds; }
  │
  │ 1;
  └────

  Add your feeds to `%feeds' hash like shown above. You can remove those
  2 `use' lines but it's good if you keep them.
m> 2012-08-19 03:43:18 +0100 committer James Booth <boothj5@gmail.com> 2012-08-19 03:43:18 +0100 Customisable logging levels' href='/danisanti/profani-tty/commit/src/main.c?id=e698738745367820e2e4bef8031c91a2a21e700a'>e6987387 ^
1248f49c ^
7c908780 ^
279737ba ^

6bad38c2 ^
41fe8c22 ^
e0dfe483 ^



6bad38c2 ^
7c908780 ^

034a9858 ^
e6987387 ^
7c908780 ^

6bad38c2 ^
7c908780 ^

72d96a92 ^
7c908780 ^

7c908780 ^

c9ed5834 ^
98bc1abb ^
72d96a92 ^
7c908780 ^
72d96a92 ^
453fcae2 ^

7c908780 ^
41fe8c22 ^


6b852a2f ^
41fe8c22 ^
6b852a2f ^

41fe8c22 ^
6b852a2f ^

1f90aca5 ^
7c908780 ^



0115d71e ^


651d5aaa ^
41fe8c22 ^
2b88e2f1 ^

41fe8c22 ^
2b88e2f1 ^


e434b1bb ^
651d5aaa ^




41fe8c22 ^
0115d71e ^




41fe8c22 ^
2490c3ed ^




bd928f0f ^





7c908780 ^
72d96a92 ^

9d2745e4 ^
5d9c7ffd ^


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
  

         
                                                            
  














                                                                       











                                                                                
   
 
                        
 
                   

                 
                            
                       
      
 
                      
                   
                            
 
                                
                          
                                 
 

                           
 
                                                                                                               



                         
                                   

                                                                                             
                                                                                                           
                                                                                                                       

                
 

                            
 

                                                              

                                                                 
                                       
                            
                 
     
 

                                   
                          


                                                                                                                  
     
                                                                        

                
                                                                     

         
                                                                                         



                                                                                                   


                                        
 
                          

                                             
                           


                                              
                                  




                                                                
                       




                                           
                         




                                           





                                         
                 

     
                                


             
/*
 * main.c
 *
 * Copyright (C) 2012 - 2016 James Booth <boothj5@gmail.com>
 *
 * This file is part of Profanity.
 *
 * Profanity is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Profanity is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Profanity.  If not, see <http://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give permission to
 * link the code of portions of this program with the OpenSSL library under
 * certain conditions as described in each individual source file, and
 * distribute linked combinations including the two.
 *
 * You must obey the GNU General Public License in all respects for all of the
 * code used other than OpenSSL. If you modify file(s) with this exception, you
 * may extend this exception to your version of the file(s), but you are not
 * obligated to do so. If you do not wish to do so, delete this exception
 * statement from your version. If you delete this exception statement from all
 * source files in the program, then also delete it here.
 *
 */

#include "prof_config.h"

#include <string.h>
#include <glib.h>

#ifdef PROF_HAVE_GIT_VERSION
#include "gitversion.h"
#endif

#include "profanity.h"
#include "common.h"
#include "command/command.h"

static gboolean version = FALSE;
static char *log = "INFO";
static char *account_name = NULL;

int
main(int argc, char **argv)
{
    if (argc == 2 && g_strcmp0(argv[1], "docgen") == 0 && g_strcmp0(PROF_PACKAGE_STATUS, "development") == 0) {
        command_docgen();
        return 0;
    }

    static GOptionEntry entries[] =
    {
        { "version", 'v', 0, G_OPTION_ARG_NONE, &version, "Show version information", NULL },
        { "account", 'a', 0, G_OPTION_ARG_STRING, &account_name, "Auto connect to an account on startup" },
        { "log",'l', 0, G_OPTION_ARG_STRING, &log, "Set logging levels, DEBUG, INFO (default), WARN, ERROR", "LEVEL" },
        { NULL }
    };

    GError *error = NULL;
    GOptionContext *context;

    context = g_option_context_new(NULL);
    g_option_context_add_main_entries(context, entries, NULL);
    if (!g_option_context_parse(context, &argc, &argv, &error)) {
        g_print("%s\n", error->message);
        g_option_context_free(context);
        g_error_free(error);
        return 1;
    }

    g_option_context_free(context);

    if (version == TRUE) {
        if (strcmp(PROF_PACKAGE_STATUS, "development") == 0) {
#ifdef PROF_HAVE_GIT_VERSION
            g_print("Profanity, version %sdev.%s.%s\n", PROF_PACKAGE_VERSION, PROF_GIT_BRANCH, PROF_GIT_REVISION);
#else
            g_print("Profanity, version %sdev\n", PROF_PACKAGE_VERSION);
#endif
        } else {
            g_print("Profanity, version %s\n", PROF_PACKAGE_VERSION);
        }

        g_print("Copyright (C) 2012 - 2016 James Booth <%s>.\n", PROF_PACKAGE_BUGREPORT);
        g_print("License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>\n");
        g_print("\n");
        g_print("This is free software; you are free to change and redistribute it.\n");
        g_print("There is NO WARRANTY, to the extent permitted by law.\n");
        g_print("\n");

        g_print("Build information:\n");

#ifdef PROF_HAVE_LIBMESODE
        g_print("XMPP library: libmesode\n");
#endif
#ifdef PROF_HAVE_LIBSTROPHE
        g_print("XMPP library: libstrophe\n");
#endif

        if (is_notify_enabled()) {
            g_print("Desktop notification support: Enabled\n");
        } else {
            g_print("Desktop notification support: Disabled\n");
        }

#ifdef PROF_HAVE_LIBOTR
        g_print("OTR support: Enabled\n");
#else
        g_print("OTR support: Disabled\n");
#endif

#ifdef PROF_HAVE_LIBGPGME
        g_print("PGP support: Enabled\n");
#else
        g_print("PGP support: Disabled\n");
#endif

#ifdef PROF_HAVE_C
        g_print("C plugins: Enabled\n");
#else
        g_print("C plugins: Disabled\n");
#endif

        return 0;
    }

    prof_run(log, account_name);

    return 0;
}