summary refs log blame commit diff stats
path: root/README
blob: 375734e47a756f9428530a47bbbbe306ec2a38ac (plain) (tree) 
4e9450f9 ^

712aa449





36e4e71e ^


712aa449

36e4e71e ^

712aa449

36e4e71e ^



4e9450f9 ^

36e4e71e ^























































306c76d8 ^
















36e4e71e ^






b6aed5ef ^

36e4e71e ^





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

                 




                                                                      

                                                             
 
        
 


                                                 
                        






















































                                                                           















                                                                        





                                                
                                                 




                          
== Ranger v.1.0.2

Ranger is a filemanager that integrates well into the linux shell and
gives you a quick way of doing operations that would otherwise require
a lot of typing, without starting up a bloated environment.

The program is written in Python since version 1.0.0 and uses
ncurses for the user interface.

== About

* Author:          hut
* Email:           hut@lavabit.com
* Git repo:        http://repo.or.cz/w/ranger.git
* Version:         1.0.2


== Features

* Multi-column display
* Preview of the selected file/directory
* Common file operations (create/chmod/copy/delete/...)
* Quickly find files or text inside files
* VIM-like controls
* Open files in external programs
* Mouse support
* Change directory of shell after exit
* Bookmarks


== Dependencies

* A Unix-like OS        (ranger is not tested on others)
* Python 2.6 or 3.1
* Python curses module


== Getting Started

At first, it's a good idea to create a symlink in your bin dir:
    sudo ln -s /path/to/ranger.py /usr/bin/ranger

Now type in ranger to start it.

You should see 4 columns. The third is the directory where you are at
the moment. To the left, there are the the directories above the current
working dir, and the column on the right is a preview of the selected
file/directory.

Now use the arrow keys to navigate, press enter to open a file.

A list of commands with short descriptions can be viewed by
pressing ? inside the program and following the instructions.
The file code/keys.rb contains all keycombinations, so that's another
place you may want to check out.
More extensive documentation will be written when enough users ask me to :)


== Opening files with Ranger

If you use the same applications like me, you'll be able to open
files by pressing the right arrow key. If not, you will have to
specify them in ranger/defaults/apps.py. It's explained
in the docstrings how exactly to do that.

Once you've set up your applications, you can also use ranger to
open files from the shell:
    ranger blabla.pdf


== Customizing Ranger

The file ranger/defaults/options.py contains most of the options.
apps.py defines how files are run, keys.py defines keybindings.

The files in ranger/defaults/ can be copied into ~/.ranger/ for per-user
modifications.  Colorschemes can be placed in ~/.ranger/colorschemes.

The options.py defines the import path of "apps", "keys" and the
colorscheme.  To use the files you placed in ~/.ranger/, you may need
to make this changes in the options.py:

"from ranger.defaults import apps, keys" => "from . import apps, keys"
"from ranger import colorschemes" => "from . import colorschemes"


== Guidelines for developers:

Tabs for indentation, spaces for tables and such

Use docstrings with pydoc in mind

Use syntax compatible to both python 2.6 and 3.1.

Version Numbering: X.Y.Z
* X: milestones
* Y: stable versions
* Z: experimental versions
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2024-12-26 17:26:27 +0000
revision' href='/danisanti/profani-tty/blame/src/xmpp/jid.c?id=1a85448bf21ee7c3e217e5cb0d51364516018075'>^ 
94bcf188 ^

a2726b6a ^



94bcf188 ^

4c78534b ^

d239a127 ^



94bcf188 ^

4c78534b ^

d239a127 ^


a2726b6a ^

70b923a7 ^

d239a127 ^

89b76400 ^

94bcf188 ^

d239a127 ^

70b923a7 ^

d239a127 ^

94bcf188 ^

d239a127 ^

5505387c ^

d239a127 ^


94bcf188 ^

5505387c ^

94bcf188 ^

d239a127 ^

94bcf188 ^


dd11334b ^

a2726b6a ^

3a22719b ^

a2726b6a ^


3a22719b ^






d827abdd ^

b5359214 ^














a2726b6a ^

d827abdd ^

a978bb12 ^


bbdc3413 ^

b5359214 ^




a978bb12 ^








d827abdd ^


ec75b5e0 ^

a2726b6a ^

ec75b5e0 ^




94bcf188 ^

2cea2639 ^


94bcf188 ^


dd11334b ^

a2726b6a ^

94bcf188 ^

a2726b6a ^


70b923a7 ^

94bcf188 ^

235339e5 ^

94bcf188 ^

a2726b6a ^

94bcf188 ^







94bcf188 ^




dd11334b ^

a2726b6a ^

94bcf188 ^

a2726b6a ^


94bcf188 ^

4c78534b ^


5505387c ^


94bcf188 ^


94bcf188 ^

94bcf188 ^

5505387c ^


e263e00a ^

e263e00a ^



dd11334b ^

a2726b6a ^

e263e00a ^






240f6a3f ^

9714d1d8 ^




a2726b6a ^

9714d1d8 ^

a2726b6a ^

f9eb302a ^

9714d1d8 ^

f9eb302a ^

9714d1d8 ^

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

140
141

142

143
144
145
146

147
148
149
150
151
152
153
154

155
156

157

158

159
160
161
162

163

164
165

166
167

168

169

170

171
172

173

174

175

176

177

178
179
180
181
182
183
184

185
186
187
188

189

190

191

192
193

194

195
196

197
198

199
200

201

202

203
204

205

206
207
208

209

210

211
212
213
214
215
216

217

218
219
220
221

222

223

224

225

226

227

228


        
                                 
  
                                                            













                                                                       
                                                                      
  











                                                                                

   

                   
                   



                   
                   
                     
 
    
                                  
 
                       
 
                                              
                                   
                          

                    
 
                               
                        
                    


                                                                           



                        
                                              
                        

                    
 
                                          
                       




                                
                       
 


                                                    
 
              


                                                                                                 
 
                 

                                                                                                               
                                                                                                   
                                                         
                                            
                           
            
                                                    
                                                      
     
 
                                     
                            

                    
 
                          
 
                  

 
    
                                                                                        
 

                                                  





                             
    













                           
                     
 

                      
     



                          







                              

 
        
                                



                                  
  

                                                                              

                                                                      
     
                                                                     
 

                                                      
                         
                                   
                                        
 
                                         






                                  



                                              
     
                                                       
 

                                                      
 

                                     

                                          

                           
     
 

                     
 


                                            
     
                                





                            
 



                         
                                      
 
                                                          
               
 
                  
 
/*
 * jid.c
 * vim: expandtab:ts=4:sts=4:sw=4
 *
 * Copyright (C) 2012 - 2019 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 <https://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 "config.h"

#include <stdlib.h>
#include <string.h>

#include <glib.h>

#include "common.h"
#include "xmpp/jid.h"

Jid*
jid_create(const gchar* const str)
{
    Jid* result = NULL;

    /* if str is NULL g_strdup returns NULL */
    gchar* trimmed = g_strdup(str);
    if (trimmed == NULL) {
        return NULL;
    }

    if (strlen(trimmed) == 0) {
        g_free(trimmed);
        return NULL;
    }

    if (g_str_has_prefix(trimmed, "/") || g_str_has_prefix(trimmed, "@")) {
        g_free(trimmed);
        return NULL;
    }

    if (!g_utf8_validate(trimmed, -1, NULL)) {
        g_free(trimmed);
        return NULL;
    }

    result = malloc(sizeof(struct jid_t));
    result->str = NULL;
    result->localpart = NULL;
    result->domainpart = NULL;
    result->resourcepart = NULL;
    result->barejid = NULL;
    result->fulljid = NULL;
    result->refcnt = 1;

    gchar* atp = g_utf8_strchr(trimmed, -1, '@');
    gchar* slashp = g_utf8_strchr(trimmed, -1, '/');
    gchar* domain_start = trimmed;

    if (atp) {
        result->localpart = g_utf8_substring(trimmed, 0, g_utf8_pointer_to_offset(trimmed, atp));
        domain_start = atp + 1;
    }

    if (slashp) {
        result->resourcepart = g_strdup(slashp + 1);
        result->domainpart = g_utf8_substring(domain_start, 0, g_utf8_pointer_to_offset(domain_start, slashp));
        char* barejidraw = g_utf8_substring(trimmed, 0, g_utf8_pointer_to_offset(trimmed, slashp));
        result->barejid = g_utf8_strdown(barejidraw, -1);
        result->fulljid = g_strdup(trimmed);
        g_free(barejidraw);
    } else {
        result->domainpart = g_strdup(domain_start);
        result->barejid = g_utf8_strdown(trimmed, -1);
    }

    if (result->domainpart == NULL) {
        jid_destroy(result);
        return NULL;
    }

    result->str = trimmed;

    return result;
}

Jid*
jid_create_from_bare_and_resource(const char* const barejid, const char* const resource)
{
    Jid* result;
    char* jid = create_fulljid(barejid, resource);
    result = jid_create(jid);
    free(jid);

    return result;
}

void
jid_auto_destroy(Jid** jid)
{
    if (jid == NULL)
        return;
    jid_destroy(*jid);
}

void
jid_ref(Jid* jid)
{
    jid->refcnt++;
}

void
jid_destroy(Jid* jid)
{
    if (jid == NULL) {
        return;
    }
    if (jid->refcnt > 1) {
        jid->refcnt--;
        return;
    }

    g_free(jid->str);
    g_free(jid->localpart);
    g_free(jid->domainpart);
    g_free(jid->resourcepart);
    g_free(jid->barejid);
    g_free(jid->fulljid);
    free(jid);
}

gboolean
jid_is_valid_room_form(Jid* jid)
{
    return (jid->fulljid != NULL);
}

/*
 * Given a barejid, and resourcepart, create and return a full JID of the form
 * barejid/resourcepart
 * Will return a newly created string that must be freed by the caller
 */
char*
create_fulljid(const char* const barejid, const char* const resource)
{
    gchar* barejidlower = g_utf8_strdown(barejid, -1);
    GString* full_jid = g_string_new(barejidlower);
    g_free(barejidlower);
    g_string_append(full_jid, "/");
    g_string_append(full_jid, resource);

    char* result = strdup(full_jid->str);

    g_string_free(full_jid, TRUE);

    return result;
}

/*
 * Get the nickname part of the full JID, e.g.
 * Full JID = "test@conference.server/person"
 * returns "person"
 */
char*
get_nick_from_full_jid(const char* const full_room_jid)
{
    char** tokens = g_strsplit(full_room_jid, "/", 0);
    char* nick_part = NULL;

    if (tokens) {
        if (tokens[0] && tokens[1]) {
            nick_part = strdup(tokens[1]);
        }

        g_strfreev(tokens);
    }

    return nick_part;
}

/*
 * get the fulljid, fall back to the barejid
 */
char*
jid_fulljid_or_barejid(Jid* jid)
{
    if (jid->fulljid) {
        return jid->fulljid;
    } else {
        return jid->barejid;
    }
}

char*
jid_random_resource(void)
{
    char* rand = get_random_string(4);

    gchar* result = g_strdup_printf("profanity.%s", rand);
    free(rand);

    return result;
}
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2024-12-26 17:26:27 +0000