forked from sean-hut/eping
-
Notifications
You must be signed in to change notification settings - Fork 1
/
eping.info
189 lines (135 loc) · 5.03 KB
/
eping.info
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
This is eping.info, produced by makeinfo version 6.7 from eping.texinfo.
File: eping.info, Node: Top, Next: Overview, Up: (dir)
Eping
*****
This manual is for Eping 0.1.1
* Menu:
* Overview::
* Dependencies::
* How to use Eping::
* Configuration::
* Eping License::
* Index::
File: eping.info, Node: Overview, Next: Dependencies, Prev: Top, Up: Top
1 Overview
**********
Eping is an Emacs package that checks internet connectivity using
'ping'.
Eping requires that you have 'ping' installed for it to work.
File: eping.info, Node: Dependencies, Next: How to use Eping, Prev: Overview, Up: Top
2 Dependencies
**************
2.1 Required Dependency
=======================
Eping requires that you have 'ping' installed. Eping uses 'ping' to
check internet connectivity.
2.2 Optional Dependency
=======================
eSpeak is an optional dependency for Eping. You need to have 'espeak'
installed if you want Eping's result to be spoken to you.
File: eping.info, Node: How to use Eping, Next: Configuration, Prev: Dependencies, Up: Top
3 How to use Eping
******************
Eping is used through it's 'eping' command.
3.1 Minibuffer Output
=====================
'M-x eping'
You will be promted for a domain to ping and then for a number of
times to ping the domain. Eping then pings the selected domain the
specified number of times with 'ping'. Eping outputs to the minibuffer
the success or failure of 'ping' to ping the domain.
3.2 eSpeak Output
=================
'C-u M-x eping'
You will be promted for a domain to ping and then for a number of
times to ping the domain. Eping then pings the selected domain the
specified number of times with 'ping'. Eping will say the success or
failure of 'ping' to ping the domain using 'espeak'.
File: eping.info, Node: Configuration, Next: Eping License, Prev: How to use Eping, Up: Top
4 Configuration
***************
4.1 Configure list of domains
=============================
The 'eping-domain-options' variable is a list of domains. When the user
runs the 'ping' function they are prompted to select from this list.
The user can configure this to be a list of domains of their choice.
Here is an example:
(setq eping-domain-options
'("haskell.org" "idris-lang.org" "rust-lang.org"))
4.2 Configure number of pings
=============================
The 'eping-domain-options' variable is a list of number strings. When
the user runs the 'ping' function they are prompted to select from this
list. The user can configure this to be a list of number strings of
their choice. Here is an example:
(setq eping-number-pings-options '("10" "20" "30"))
File: eping.info, Node: Eping License, Next: Index, Prev: Configuration, Up: Top
Appendix A Eping License
************************
Copyright (C) 2020 Sean Hutchings
Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
File: eping.info, Node: Index, Prev: Eping License, Up: Top
Index
*****
Concept Index
=============
[index ]
* Menu:
* Configuration: Configuration. (line 5)
* Configure list of domains: Configuration. (line 9)
* Configure number of pings: Configuration. (line 20)
* Dependencies: Dependencies. (line 5)
* eSpeak output: How to use Eping. (line 21)
* How to use Eping: How to use Eping. (line 6)
* License: Eping License. (line 6)
* Minibuffer output: How to use Eping. (line 11)
* Optional dependency: Dependencies. (line 15)
* Overview: Overview. (line 6)
* Required dependency: Dependencies. (line 9)
Keystroke Index
===============
[index ]
* Menu:
* eping eSpeak: How to use Eping. (line 21)
* eping minibuffer: How to use Eping. (line 11)
Function Index
==============
[index ]
* Menu:
* eping: How to use Eping. (line 11)
Variable Index
==============
[index ]
* Menu:
* eping-domain-options: Configuration. (line 9)
* eping-number-pings-options: Configuration. (line 20)
Tag Table:
Node: Top74
Node: Overview287
Node: Dependencies531
Node: How to use Eping982
Node: Configuration1800
Node: Eping License2683
Node: Index3471
End Tag Table
Local Variables:
coding: utf-8
End: